Release Notes

v2026.01.0 (January 27, 2026)

This release updates calendar_average and climate_anomaly to allow for monthly data with non-uniform spacing, rewrites heat_index to be more in line with the NWS implementation, and updates pressure_at_hybrid_levels and interp_hybrid_to_pressure to allow for multidimensional hybrid coefficients for xarray inputs.

New Features

• Update calendar_average and climate_anomaly to allow for monthly data with non-uniform spacing by Katelyn FitzGerald in (PR805, PR809)

Bug Fixes

• Rewrite heat_index so that the calculation is be more in line with the NWS implementation and removes internal functions _xheat_index and _heat_index by Anissa Zacharias in (PR807)

• Update pressure_at_hybrid_levels and interp_hybrid_to_pressure to allow for multidimensional hybrid coefficients for xarray inputs by Anissa Zacharias in (PR811)

Documentation

• Update logos and color schemes by Anissa Zacharias in (PR813)

v2025.12.1 (December 17, 2025)

This release fixes a bug in nmse and adds a new function, delta_pressure_hybrid.

New Features

• Adds delta_pressure_hybrid function by Anissa Zacharias in (PR797)

• Add a pressure_top argument to delta_pressure by Anissa Zacharias`_ in (PR798)

Bug Fixes

• Fix nmse coordinate matching issue Anissa Zacharias in (PR796)

Documentation

• Add delta_pressure calculation reference by Anissa Zacharias in (PR800)

v2025.12.0 (December 2, 2025)

This release adds a normalized mean squared error metric function.

New Features

• Add normalized mean square error (NMSE) metric function, nmse by Anissa Zacharias in (PR787)

v2025.11.0 (November 24, 2025)

This release adds an initial benchmarking suite, exposes a new pressure_at_hybrid_levels function, and addresses several attribute related issues following upstream changes in Xarray.

Bug Fixes

• Update climate_anomaly to ensure consistent behavior for the keep_attrs option by Katelyn FitzGerald in (PR783)

• Revert back to passing only pressure.data rather than the full DataArray to avoid unit handling issues in interp_hybrid_to_pressure by Katelyn FitzGerald in (PR781)

New Features

• Move _pressure_from_hybrid to public API as pressure_at_hybrid_levels by Anissa Zacharias in (PR776)

Developer Features

• Create initial benchmarking suite by Anissa Zacharias in (PR772)

Documentation

• Add latitude/longitude axis labels in vimfc example plot by Cora Schneck in (PR784)

v2025.10.01 (October 7, 2025)

This release updates to dependabot and optional PR ASV runs

Internal Changes

• Group Dependabot updates by Katelyn FitzGerald in (PR764)

v2025.09.0 (September 9, 2025)

This release removes dask as a mandatory dependency and reworks some internal dask usage.

Breaking Changes

• scale_voronoi no longer accepts chunk_size as an optional argument and will not automatically chunk xarray inputs from Anissa Zacharias in (PR749)

Internal Changes

• Update interp_hybrid_to_pressure to remove forced dask usage by Anissa Zacharias in (PR748)

• Remove dask as an explicit dependency and forced dask internal usage by Anissa Zacharias in (PR749)

Developer Features

• Add option to enable asv comparison runs on PR branches by Anissa Zacharias in (PR753)

Documentation

• Update links to cartopy docs by Katelyn FitzGerald in (PR757)

v2025.07.0 (July 15, 2025)

This release updates packaging, replaces deprecated xarray functionality, and addresses a bug in interp_hybrid_to_pressure.

Bug Fixes

• Change interp_hybrid_to_pressure to use t_bot directly for temperature extrapolation rather than the temperature from the (sometimes incorrectly) presumed lowest level by Katelyn FitzGerald in (PR737)

Internal Changes

• Replace deprecated xarray.cftime_range with xarray.date_range by Katelyn FitzGerald in (PR739)

Maintenance

• Streamline packaging and dependencies by Katelyn FitzGerald in (PR740)

v2025.05.0 (May 20, 2025)

This release includes documentation improvements, fixes a delta_pressure thickness bug, and adds improved CFTime and Datetime object compatibility to climatology functionality.

Documentation

• Remove reference to NCAR/geocat repo from support page by Katelyn FitzGerald in (PR709)

• Add additional relative humidity documentation by Cora Schneck in (PR710)

• Clarify definition of delta_pressure by Katelyn FitzGerald in (PR718)

• Correct psychrometric_constant equation references in documentation by Cora Schneck in (PR723)

• Add note about alternate hybrid-sigma pressure formulation to interp_hybrid_to_pressure docs by Katelyn FitzGerald in (PR727)

Bug Fixes

• Update near surface pressure thickness calculations in delta_pressure for consistency with NCL by Katelyn FitzGerald in (PR726)

• Updates internal climatology function to ensure compatibility with both CFTime and Datetime indices by Katelyn FitzGerald in (PR717)

Internal Changes

• Updates GitHub Actions workflows per new guidance by Cora Schneck in (PR716)

• Adds blackdoc to linter for rst and markdown by Cora Schneck in (PR720)

• Unpins asv and adds Python 3.13 to benchmarking matrix by Anissa Zacharias in (PR722)

• Updates to GitHub Actions workflows by Katelyn FitzGerald in (PR733)

v2025.03.0 (March 25, 2025)

This release unpins scipy, establishes minimum version testing, and switches from yapf to ruff formatting.

Enhancements

• Add minimum dependency version testing and address minor compatibility issues with Pandas and Xarray by Katelyn FitzGerald in (PR699)

Internal Changes

• Reconfigure analytics by Katelyn FitzGerald in (PR698)

• Remove docformatter and setup ruff by Cora Schneck in (PR700)

Bug Fixes

• Unpin scipy and update sph_harm to sph_harm_y by Anissa Zacharias in (PR695)

Breaking Changes

• The chunk_size parameter was removed from decomposition() and recomposition() in (PR695)

v2025.02.0 (February 25, 2025)

This release adds support and testing for Python 3.13, unpins numpy dependency, increases support for non-nanosecond datetime objects, and updates our code of conduct.

Enhancements

• Add tests and support for non-nanosecond datetime objects by Katelyn FitzGerald in (PR691)

Maintenance

• Add support and testing for Python 3.13 by Katelyn FitzGerald in (PR688)

• Remove NumPy version pin by Katelyn FitzGerald in (PR686)

Documentation

• Updates Code of Conduct by Orhan Eroglu in 48b16cc

v2025.01.0 (January 28, 2025)

v2025.01.0 releases a collection of small changes and pins scipy to <1.15 while we finalize removing the deprecating sph_harm in favor of sph_harm_y.

Documentation

• Fix to documentation theme configuration by Katelyn FitzGerald in (PR657)

• Update links to eofs documentation by Katelyn FitzGerald in (PR661)

• Update citation documentation removing reference to old GeoCAT website by Katelyn FitzGerald in (PR666)

• Fix link to satvpr_slope_fao56 in saturation_vapor_pressure_slope documentation by Cora Schneck in (PR671)

Internal Changes

• Pin SciPy version <1.15 by Katelyn FitzGerald in (PR674)

• Temporarily remove docformatter from pre-commit by Katelyn FitzGerald in (PR653)

• Pre-commit hook to check for valid yml by Cora Schneck in (PR625)

• CI to run on macos-latest instead of macos-14 by Cora Schneck in (PR617)

• Update and setup autoupdate for pre-commit hooks by Cora Schneck in (PR604)

• Removed pre-commit.yaml action in favor of pre-commit.ci by Cora Schneck in (PR608)

• Remove ASV version pin and pin Conda version for benchmarking workflow by Katelyn FitzGerald in (PR610)

• Updates to issue and PR templates by Anissa Zacharias in (PR612)

• Re-pin ASV and list env info by Katelyn FitzGerald in (PR613)

• Refactor pre-commit.ci by Anissa Zacharias in (PR628)

• Temporarily pin micromamba for CI by Anissa Zacharias in (PR645)

• Remove micromamba pin for CI by Katelyn FitzGerald in (PR650)

v2024.04.0 (April 23, 2024)

This release drops compatibility for Python 3.9 and improves performance for interp_hybrid_to_pressure.

Breaking Changes

• Drop Python 3.9 Support by Cora Schneck in (PR599)

Bug Fixes

• Fix to address slow execution times for interp_hybrid_to_pressure with extrapolation by Katelyn FitzGerald in (PR592)

• Pin numpy<2.0 for occasional PyPI install issues by Anissa Zacharias in (PR600)

Internal Changes

• Update build in pypi workflow and documentation links to reduce warnings in testing and docs by Cora Schneck in (PR582)

v2024.03.0 (March 29, 2024)

This release includes a bug fix for delta_pressure.

Internal Changes

• Additional pre-commit hook for codespell by Cora Schneck in (PR579)

• Remove unused imports, unused variables, code cleanup Cora Schneck in (PR584)

• Add M1 runners to CI by Katelyn FitzGerald in (PR581)

• Reorganize dask compatibility tests by Anissa Zacharias in (PR568)

Bug Fixes

• Fix delta_pressure to handle the case where pressure level(s) are greater than surface pressure by Katelyn FitzGerald in (PR571)

v2024.02.0 (February 28, 2024)

This release switches the package to use an implicit namespace and adds support for Python 3.12.

Documentation

• Override branding for light/dark theme by Cora Schneck in (PR545)

• Updated outdated documentation Cora Schneck in (PR561)

Internal Changes

• Update hourly frequency aliases by Katelyn FitzGerald in (PR550)

• Python 3.12 Support by Cora Schneck in (PR548)

• Added linkcheck_ignore to docs/conf.py to address erroneous failures Anissa Zacharias in (PR559)

• Updated Codecov upload to use token by Anissa Zacharias in (PR566)

• Convert to implicit namespace packaging set up by Anissa Zacharias in (PR563)

• Temporarily pin ASV to <0.6.2 by Anissa Zacharias in (PR556 and PR569)

v2024.01.0 (January 30, 2023)

This release primarily updates our internal CI.

Internal Changes

• Upstream CI improvements by Anissa Zacharias in (PR527)

• CI improvements by Anissa Zacharias in (PR528)

• Switch to PyPI Trusted Publishing by Anissa Zacharias in (PR534)

• Add retry actions to CI by Anissa Zacharias in (PR532)

• Improves/standardizes release tests and adds PyPI release testing by Anissa Zacharias in (PR531)

• Updates upstream dev workflow to use scientific-python-nightly-wheels by Anissa Zacharias and Katelyn FitzGerald in (PR537)

Documentation

• Update remaining assets to comply with NSF branding theme by Cora Schneck in (PR541)

v2023.12.0 (December 5, 2023)

This release adds official windows support and unpins xarray and numpy.

Internal Changes

• Remove unnecessary tag publish trigger for ASV benchmarking CI by Anissa Zacharias in (PR509)

• Add windows to testing strategy by AnshRoshan in (PR460)

Bug Fixes

• Unpin xarray in environment builds with changes to interpolation.py (specify dims in xr.DataArray) and climatologies.py (replace loffset with to_offset) by Cora Schneck in (PR492)

• Fixes for Windows tests when EOF throws different signs by Cora Schneck in (PR516)

• Fix extlinks for Sphinx 6 compatibility by Anissa Zacharias in (PR520)

Maintenance

• Remove no longer needed numpy version pin by Katelyn FitzGerald in (PR515)

Documentation

• Transferred fourier filter example from Geocat-examples by Julia Kent in (PR511)

• Updated documentation links by Anissa Zacharias in (PR518)

• Augment documentation for interp_multidim by Katelyn FitzGerald in (PR504)

v2023.10.1 (October 31, 2023)

This release includes minor changes to documentation, a full conversion to pytest from unittest, and is the first release to include automated benchmarking.

Maintenance

• Convert Unittest to Pytest by Cora Schneck in (PR478)

Documentation

• Updated office hours link by Anissa Zacharias in (PR495)

• Added benchmark badge to README by Anissa Zacharias in (PR497)

Bug Fixes

• Fix Python version in upstream CI by Philip Chmielowiec in (PR436)

Internal Changes

• Add benchmarking to commits to main and tagged releases by Anissa Zacharias in (PR496)

• Fix benchmarking workflow failures by Anissa Zacharias in (PR499)

v2023.10.0 (Oct 3, 2023)

This release adds a code of conduct, minor edits to our contributor’s guide, and sets up some structure for future ASV benchmarking

Internal Changes

• Sets up ASV for benchmarking by Anissa Zacharias in (PR474)

Documentation

• New Code of Conduct by Cora Schneck in (PR461)

• Updated Pull Request Template by Cora Schneck in (PR468)

• Fixes for Contributing Geocat-Comp Contributing by Cora Schneck in (PR476)

v2023.09.0 (Sept 8, 2023)

This release adds custom_seasons to climatology_average and adds a new Contributor’s Guide to the documentation.

New Features

• User-defined seasonal boundaries, custom_seasons, enabled for climatology_average by Julia Kent in (PR411)

Bug Fixes

• Fix codecov coverage reporting issue by Anissa Zacharias in (PR446)

• Fix xarray inconsistent pinning issue by Anissa Zacharias in (PR458)

Documentation

• New Contributor’s Guide by Anissa Zacharias in (PR450)

v2023.06.1 (June 23, 2023)

This releases fixes the unintentional limitation of the 2023.06.0 release to python 3.11.0

Bug Fixes

• Fix python version limit of 3.11.0 by Anissa Zacharias in (PR431)

v2023.06.0 (June 23, 2023)

This release removes the geocat-f2py dependency. To use these functions, users will need to install the geocat-f2py package directly. Additionally, this release also drops support for python 3.8 and adds support for 3.11.

Documentation

• New Vertically Integrated Moisture Flux Convergence (VIMFC) example by Julia Kent in (PR388)

Internal Changes

• Updates deprecated pre-commit YAPF repository from pre-commit/mirrors-yapf to google/yapf by Anissa Zacharias in (PR417)

• Reconfigures package structure to remove top level src/ directory by Anissa Zacharias in (PR419)

Breaking Changes

• Removed deprecated functions climatology and anomaly by Anissa Zacharias in (PR416)

• Removed internal functions _find_time_invariant_vars and _setup_clim_anom_input by Anissa Zacharias in (PR416)

• Dropped support for python 3.8 (and added support for python 3.11) by Anissa Zacharias in (PR426)

• Removed geocat-f2py dependency by Anissa Zacharias in (PR421)

Bug Fixes

• Fix bug in _temp_extrapolate used by interp_hybrid_to_pressure by Katelyn FitzGerald in (PR424)

v2023.05.0 (4 May 2023)

In this release, we’ve added support for numpy input and other improvements to the gradient function

Bug Fixes

• Support for numpy input types and lat/lon kwargs in gradient by Julia Kent and Alea Kootz in (PR385)

Documentation

• Update PR template to include manual addition to release notes by Anissa Zacharias in (PR397)

v2023.03.2 (Mar 29, 2023)

Bug Fixes

• type check patch in delta_pressure by Julia Kent in (PR363)

Maintenance

• Update internal links to use sphinx internal referencing by Heather Craker in (PR376)

• Switch pypi release action to be triggered manually by Anissa Zacharias in (PR390)

• Package setup refactor (namespace and versioning fixes) (x2) by Anissa Zacharias (PR389)

Full Changelog: https://github.com/NCAR/geocat-comp/compare/v2023.03.1…v2023.03.2

v2023.03.1 (Mar 23, 2023)

Bug Fixes

• Add dpres_plev init file by Heather Craker in (PR368)

• Fix argument checks for interp_hybrid_to_pressure by Heather Craker in (PR372)

• Extrap args fix by Heather Craker in (PR369)

• Revert “Extrap args fix” by Heather Craker in (PR371)

Documentation

• Create a utility function to generate docstrings on wrapper functions by Anissa Zacharias in (PR362)

• adjust calendar example to follow similar template by Julia Kent in (PR339)

• Update release notes for v2023.03.0 by Heather Craker in (PR365)

Misc

• version bump 2023 03 1 by Alea Kootz in (PR379)

Full Changelog: https://github.com/NCAR/geocat-comp/compare/v2023.03.0…v2023.03.1

v2023.03.0 (Mar 2, 2023)

New Features

• Adding method to calculate delta pressure by Julia Kent in (PR338)

Deprecations

• Remove deprecated functions from v2022.10.0 by Heather Craker in (PR357)

• Remove links to deleted function docs by Heather Craker in (PR359)

Bug Fixes

• Partial fix for _vertical_remap_extrap bug by Heather Craker in (PR360)

Documentation

• Fix typos in PR template by Heather Craker in (PR353)

• add climatology_average example by Julia Kent in (PR341)

• Fix some delta_pressure docs formatting by Heather Craker in (PR361)

Maintenance

• Add PR template to repository by Heather Craker in (PR344)

• Fix typos by Heather Craker in (PR347)

• Change conda badge to conda-forge channel by Heather Craker in (PR349)

New Contributors

• Julia Kent made their first contribution in (PR341)

Full Changelog: https://github.com/NCAR/geocat-comp/compare/v2023.02.0…v2023.03.0

v2023.02.0 (Feb 2, 2023)

New Features

• Add extrapolation feature to interp_hybrid_to_pressure by Heather Craker in (PR237)

• Add climate_anomaly by Heather Craker in (PR332)

Enhancements

• Add check to avoid calculating monthly averages on monthly data by Heather Craker in (PR304)

• Add keep_attrs to climatology functions by Heather Craker in (PR315)

Deprecations

• Fix pint bug in showalter_index and deprecate by Heather Craker in (PR319)

• Replace and deprecate anomaly and climatology by Heather Craker in (PR332)

Documentation

• Add rendered equations to docstrings by Anissa Zacharias in (PR294)

• Fix badge links by Anissa Zacharias in (PR321)

Maintenance

• Adding import nightly CI test by Anissa Zacharias in (PR300)

• Expand upstream CI by Anissa Zacharias in (PR301)

• Patch for import test by Anissa Zacharias in (PR302)

• Fix the import package CI test by Anissa Zacharias in (PR303)

• CI failures quick patch by Anissa Zacharias in (PR312)

• Resolve CI link-check issue by Anissa Zacharias in (PR316)

• Pin numpy for numba compatibility by Anissa Zacharias in (PR325)

• Improve speed of spherical harmonics tests by Alea Kootz in (PR327)

• Converting pytest to unittest for climatology.py by Heather Craker in (PR331)

• Allow upstream-dev to run on forks by Anissa Zacharias in (PR335)

Full Changelog: https://github.com/NCAR/geocat-comp/compare/v2022.11.0…v2023.02.0

v2022.11.0 (Nov 17, 2022)

Documentation

• Docstring improvements by Heather Craker in (PR284)

• Update dependency list by Heather Craker in (PR293)

Maintenance

• Module reorganization by Heather Craker in (PR266)

• Update to conda-build badge link by Mario Rodriguez in (PR288)

Full Changelog: https://github.com/NCAR/geocat-comp/compare/v2022.10.1…v2022.11.0

v2022.10.1 (Oct. 28, 2022)

Bug Fixes

• Pinned Pint version by Mario Rodriguez in (PR281)

Full Changelog: https://github.com/NCAR/geocat-comp/compare/v2022.10.0…v2022.10.1

v2022.10.0 (Oct. 21, 2022)

New Features

• Gradient, arc_lon_wgs84, arc_lat_wgs84, rad_lat_wgs84 by Alea Kootz in (PR256)

Documentation

• Creating quick start guide as part of overall docs improvements by Heather Craker in (PR249)

• Documentation style overhaul by Anissa Zacharias in (PR260)

Maintenance

• Make local install for docs better by Anissa Zacharias in (PR273)

• Documentation and Link Checker by Anissa Zacharias in (PR274)

Full Changelog: https://github.com/NCAR/geocat-comp/compare/v2022.08.0…v2022.10.0