From a750c0110cb8071ec42003557265de32d9eb4054 Mon Sep 17 00:00:00 2001 From: Tom Vo Date: Wed, 25 Sep 2024 15:26:20 -0700 Subject: [PATCH 1/4] Bump to 0.7.2 --- setup.py | 2 +- tbump.toml | 2 +- xcdat/__init__.py | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/setup.py b/setup.py index 4180aa13..4c2c0e15 100755 --- a/setup.py +++ b/setup.py @@ -36,6 +36,6 @@ test_suite="tests", tests_require=test_requires, url="https://github.com/xCDAT/xcdat", - version="0.7.1", + version="0.7.2", zip_safe=False, ) diff --git a/tbump.toml b/tbump.toml index e7750dfa..d6318bb0 100644 --- a/tbump.toml +++ b/tbump.toml @@ -2,7 +2,7 @@ github_url = "https://github.com/xCDAT/xcdat" [version] -current = "0.7.1" +current = "0.7.2" # Example of a semver regexp. # Make sure this matches current_version before diff --git a/xcdat/__init__.py b/xcdat/__init__.py index 739c1fce..ac668959 100644 --- a/xcdat/__init__.py +++ b/xcdat/__init__.py @@ -20,4 +20,4 @@ from xcdat.temporal import TemporalAccessor # noqa: F401 from xcdat.utils import compare_datasets # noqa: F401 -__version__ = "0.7.1" +__version__ = "0.7.2" From 6534ca2e899876d52941a2e92802e0291f86013b Mon Sep 17 00:00:00 2001 From: tomvothecoder Date: Wed, 2 Oct 2024 09:41:10 -0700 Subject: [PATCH 2/4] Update changelog --- HISTORY.rst | 48 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 48 insertions(+) diff --git a/HISTORY.rst b/HISTORY.rst index e48160b7..524166e4 100644 --- a/HISTORY.rst +++ b/HISTORY.rst @@ -2,6 +2,54 @@ History ======= +v0.7.2 (02 October 2024) +------------------------ + +This patch release introduces significant performance improvements to +the temporal grouping averaging APIs (``group_average``, +``climatology``, and ``departures``) and adds support for piControl and +other simulations that have time coordinates starting at year 1 (e.g., +“0001-01-01”) when dropping incomplete seasons. + +Enhancements +~~~~~~~~~~~~ + +- [Refactor] Improve the performance of temporal group averaging by + @tomvothecoder in https://github.com/xCDAT/xcdat/pull/689 + +Bug Fixes +~~~~~~~~~ + +- Update temporal.py to properly handle piControl and other simulations + that start at year 1 when dropping incomplete seasons by @lee1043 in + https://github.com/xCDAT/xcdat/pull/696 + +Documentation +~~~~~~~~~~~~~ + +- Add project logos to README and project overview page on docs by + @tomvothecoder in https://github.com/xCDAT/xcdat/pull/686 +- Add links to JOSS and DOE EESM content by @tomvothecoder in + https://github.com/xCDAT/xcdat/pull/682 +- Add SciPy 2024 talk material by @tomvothecoder in + https://github.com/xCDAT/xcdat/pull/658, + https://github.com/xCDAT/xcdat/pull/678, + https://github.com/xCDAT/xcdat/pull/679, + https://github.com/xCDAT/xcdat/pull/680 +- Add JOSS badge to README by @tomvothecoder in + https://github.com/xCDAT/xcdat/pull/674 + +DevOps +~~~~~~ + +- Update ``setup.py`` classifiers by @tomvothecoder in + https://github.com/xCDAT/xcdat/pull/691 +- Update build workflow by @tomvothecoder in + https://github.com/xCDAT/xcdat/pull/698 + +**Full Changelog**: https://github.com/xCDAT/xcdat/compare/v0.7.1 + + v0.7.1 (24 June 2024) ---------------------- From 1a3f04b955aca3492472315c8d65aae5fc42ab92 Mon Sep 17 00:00:00 2001 From: tomvothecoder Date: Wed, 2 Oct 2024 09:43:06 -0700 Subject: [PATCH 3/4] Update GH tags on changelog --- HISTORY.rst | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/HISTORY.rst b/HISTORY.rst index 524166e4..a57997ef 100644 --- a/HISTORY.rst +++ b/HISTORY.rst @@ -15,39 +15,39 @@ Enhancements ~~~~~~~~~~~~ - [Refactor] Improve the performance of temporal group averaging by - @tomvothecoder in https://github.com/xCDAT/xcdat/pull/689 + `Tom Vo`_ in https://github.com/xCDAT/xcdat/pull/689 Bug Fixes ~~~~~~~~~ - Update temporal.py to properly handle piControl and other simulations - that start at year 1 when dropping incomplete seasons by @lee1043 in + that start at year 1 when dropping incomplete seasons by `Jiwoo Lee`_ in https://github.com/xCDAT/xcdat/pull/696 Documentation ~~~~~~~~~~~~~ - Add project logos to README and project overview page on docs by - @tomvothecoder in https://github.com/xCDAT/xcdat/pull/686 -- Add links to JOSS and DOE EESM content by @tomvothecoder in + `Tom Vo`_ in https://github.com/xCDAT/xcdat/pull/686 +- Add links to JOSS and DOE EESM content by `Tom Vo`_ in https://github.com/xCDAT/xcdat/pull/682 -- Add SciPy 2024 talk material by @tomvothecoder in +- Add SciPy 2024 talk material by `Tom Vo`_ in https://github.com/xCDAT/xcdat/pull/658, https://github.com/xCDAT/xcdat/pull/678, https://github.com/xCDAT/xcdat/pull/679, https://github.com/xCDAT/xcdat/pull/680 -- Add JOSS badge to README by @tomvothecoder in +- Add JOSS badge to README by `Tom Vo`_ in https://github.com/xCDAT/xcdat/pull/674 DevOps ~~~~~~ -- Update ``setup.py`` classifiers by @tomvothecoder in +- Update ``setup.py`` classifiers by `Tom Vo`_ in https://github.com/xCDAT/xcdat/pull/691 -- Update build workflow by @tomvothecoder in +- Update build workflow by `Tom Vo`_ in https://github.com/xCDAT/xcdat/pull/698 -**Full Changelog**: https://github.com/xCDAT/xcdat/compare/v0.7.1 +**Full Changelog**: https://github.com/xCDAT/xcdat/compare/v0.7.1...v0.7.2 v0.7.1 (24 June 2024) From 61fae852ebfd0a5c370e3687ee914097ab667608 Mon Sep 17 00:00:00 2001 From: tomvothecoder Date: Wed, 2 Oct 2024 11:37:13 -0700 Subject: [PATCH 4/4] Remove `bool` from dataset.py API docstrings --- xcdat/dataset.py | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/xcdat/dataset.py b/xcdat/dataset.py index 32522bd6..12f058dd 100644 --- a/xcdat/dataset.py +++ b/xcdat/dataset.py @@ -1,4 +1,5 @@ """Dataset module for functions related to an xarray.Dataset.""" + from __future__ import annotations import os @@ -63,7 +64,7 @@ def open_dataset( data_var: Optional[str], optional The key of the non-bounds data variable to keep in the Dataset, alongside any existing bounds data variables, by default None. - add_bounds: List[CFAxisKey] | None | bool + add_bounds: List[CFAxisKey] | None List of CF axes to try to add bounds for (if missing), by default ["X", "Y"]. Set to None to not add any missing bounds. Please note that bounds are required for many xCDAT features. @@ -152,7 +153,7 @@ def open_mfdataset( If concatenation along more than one dimension is desired, then ``paths`` must be a nested list-of-lists (see [2]_ ``xarray.combine_nested`` for details). - add_bounds: List[CFAxisKey] | None | bool + add_bounds: List[CFAxisKey] | None List of CF axes to try to add bounds for (if missing), by default ["X", "Y"]. Set to None to not add any missing bounds. Please note that bounds are required for many xCDAT features. @@ -464,7 +465,7 @@ def _postprocess_dataset( dataset: xr.Dataset, data_var: Optional[str] = None, center_times: bool = False, - add_bounds: List[CFAxisKey] | None | bool = ["X", "Y"], + add_bounds: List[CFAxisKey] | None = ["X", "Y"], lon_orient: Optional[Tuple[float, float]] = None, ) -> xr.Dataset: """Post-processes a Dataset object. @@ -479,7 +480,7 @@ def _postprocess_dataset( If True, center time coordinates using the midpoint between its upper and lower bounds. Otherwise, use the provided time coordinates, by default False. - add_bounds: List[CFAxisKey] | None | bool + add_bounds: List[CFAxisKey] | None List of CF axes to try to add bounds for (if missing), default ["X", "Y"]. Set to None to not add any missing bounds.