Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Bump to v0.7.2 #700

Merged
merged 4 commits into from
Oct 2, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 48 additions & 0 deletions HISTORY.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
`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 `Jiwoo Lee`_ in
https://github.com/xCDAT/xcdat/pull/696

Documentation
~~~~~~~~~~~~~

- Add project logos to README and project overview page on docs by
`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 `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 `Tom Vo`_ in
https://github.com/xCDAT/xcdat/pull/674

DevOps
~~~~~~

- Update ``setup.py`` classifiers by `Tom Vo`_ in
https://github.com/xCDAT/xcdat/pull/691
- 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...v0.7.2


v0.7.1 (24 June 2024)
----------------------

Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -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,
)
2 changes: 1 addition & 1 deletion tbump.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion xcdat/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -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"
9 changes: 5 additions & 4 deletions xcdat/dataset.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
"""Dataset module for functions related to an xarray.Dataset."""

from __future__ import annotations

import os
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand All @@ -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.

Expand Down
Loading