From 2325f29e4ae5591fb67b2f09136f1cc90ef734d3 Mon Sep 17 00:00:00 2001 From: Tom Vo Date: Tue, 10 Oct 2023 13:50:10 -0700 Subject: [PATCH] Bump to v0.6.0 (#555) * Add VS Code debugger config * Update changelog and fix FAQs link --- .vscode/xcdat.code-workspace | 22 +++++++++ HISTORY.rst | 91 ++++++++++++++++++++++++++++++++++++ docs/faqs.rst | 4 +- setup.py | 2 +- tbump.toml | 2 +- xcdat/__init__.py | 2 +- 6 files changed, 118 insertions(+), 5 deletions(-) diff --git a/.vscode/xcdat.code-workspace b/.vscode/xcdat.code-workspace index bdfe5127..906eb68e 100644 --- a/.vscode/xcdat.code-workspace +++ b/.vscode/xcdat.code-workspace @@ -7,6 +7,9 @@ "path": ".." } ], + // =========================== + // VS Code Workspace Settings + // =========================== "settings": { // =================== // Editor settings @@ -49,5 +52,24 @@ "editor.wordWrap": "wordWrapColumn", "editor.wordWrapColumn": 120 } + }, + // ===================================== + // VS Code Python Debugger Configuration + // ===================================== + "launch": { + "version": "0.2.0", + "configurations": [ + { + "name": "Python: Current File", + "type": "python", + "request": "launch", + "program": "${file}", + "console": "integratedTerminal", + "justMyCode": true, + "env": { + "PYTHONPATH": "${workspaceFolder}" + } + } + ] } } diff --git a/HISTORY.rst b/HISTORY.rst index 7338f138..0ee4a1b3 100644 --- a/HISTORY.rst +++ b/HISTORY.rst @@ -2,6 +2,97 @@ History ======= +v0.6.0 (10 October 2023) +------------------------ + +This minor version update consists of new features including vertical +regridding (extension of ``xgcm``), functions for producing accurate +time bounds, and improving the usability of the ``create_grid`` API. It +also includes bug fixes to preserve attributes when using regrid2 +horizontal regridder and fixing multi-file datasets spatial average +orientation and weights when lon bounds span prime meridian. + +Features +-------- + +- Functions to produce accurate time bounds by `Stephen Po-Chedley`_ in + https://github.com/xCDAT/xcdat/pull/418 +- Add API extending xgcm vertical regridding by `Jason Boutte`_ in + https://github.com/xCDAT/xcdat/pull/388, + https://github.com/xCDAT/xcdat/pull/535, + https://github.com/xCDAT/xcdat/pull/525 +- Update ``create_grid`` args to improve usability by `Jason Boutte`_ in + https://github.com/xCDAT/xcdat/pull/507, + https://github.com/xCDAT/xcdat/pull/539 + +Deprecation +----------- + +- Add deprecation warnings for ``add_bounds`` boolean args by + `Tom Vo`_ in https://github.com/xCDAT/xcdat/pull/548, +- Add deprecation warning for CDML/XML support in ``open_mfdataset()`` by `Tom Vo`_ + in https://github.com/xCDAT/xcdat/pull/503, + https://github.com/xCDAT/xcdat/pull/504 + +Bug Fixes +--------- + +Horizontal Regridding +~~~~~~~~~~~~~~~~~~~~~ + +- Improves error when axis is missing/incorrect attributes with regrid2 + by `Jason Boutte`_ in https://github.com/xCDAT/xcdat/pull/481 +- Fixes preserving ds/da attributes in the regrid2 module by `Jason Boutte`_ + in https://github.com/xCDAT/xcdat/pull/468 +- Fixes duplicate parameter in regrid2 docs by `Jason Boutte`_ in + https://github.com/xCDAT/xcdat/pull/532 + +Spatial Averaging +~~~~~~~~~~~~~~~~~ +- Fix multi-file dataset spatial average orientation and weights when + lon bounds span prime meridian by `Stephen Po-Chedley`_ in + https://github.com/xCDAT/xcdat/pull/495 + +Documentation +------------- + +- Typo fix for climatology code example in docs by `Jiwoo Lee`_ in + https://github.com/xCDAT/xcdat/pull/491 +- Update documentation in regrid2.py by `Jiwoo Lee`_ in + https://github.com/xCDAT/xcdat/pull/509 +- Add more fields to GH Discussions question form by `Tom Vo`_ in + https://github.com/xCDAT/xcdat/pull/480 +- Add Q&A GH discussions template by `Tom Vo`_ in + https://github.com/xCDAT/xcdat/pull/479 +- Update FAQs question covering datasets with conflicting bounds by + `Tom Vo`_ in https://github.com/xCDAT/xcdat/pull/474 +- Add Google Groups mailing list to docs by `Tom Vo`_ in + https://github.com/xCDAT/xcdat/pull/452 +- Fix README link to CODE-OF-CONDUCT.rst by `Tom Vo`_ in + https://github.com/xCDAT/xcdat/pull/444 +- Replace LLNL E3SM License with xCDAT License by `Tom Vo`_ in + https://github.com/xCDAT/xcdat/pull/443 +- Update getting started and HPC documentation by `Tom Vo`_ in + https://github.com/xCDAT/xcdat/pull/553 + +DevOps +------ + +- Fix Python deprecation comment in conda env yml files by + `Tom Vo`_ in https://github.com/xCDAT/xcdat/pull/514 +- Simplify conda environments and move configs to ``pyproject.toml`` by + `Tom Vo`_ in https://github.com/xCDAT/xcdat/pull/512 +- Update DevOps to cache conda and fix attributes not being preserved + with ``xarray > 2023.3.0`` by `Tom Vo`_ in + https://github.com/xCDAT/xcdat/pull/465 +- Update GH Actions to use ``mamba`` by `Tom Vo`_ in + https://github.com/xCDAT/xcdat/pull/450 +- Update constraint ``cf_xarray >=0.7.3`` to workaround xarray import + issue by `Tom Vo`_ in https://github.com/xCDAT/xcdat/pull/547 + +**Full Changelog**: https://github.com/xCDAT/xcdat/compare/v0.5.0...v0.6.0 + + v0.5.0 (27 March 2023) -------------------------- diff --git a/docs/faqs.rst b/docs/faqs.rst index 5b4c3037..aaeec884 100644 --- a/docs/faqs.rst +++ b/docs/faqs.rst @@ -228,13 +228,13 @@ For more information on these options, visit the `xarray.open_mfdataset`_ docume Regridding ---------- -``xcdat`` extends and provides a uniform interface to `xESMF`_ and `xgcm`_. In addition, ``xcdat`` provides a port of the ``CDAT`` `regrid2`_ package. +``xcdat`` extends and provides a uniform interface to `xESMF`_ and `xgcm`_. In addition, ``xcdat`` provides a port of the ``CDAT`` `regrid2 package`_. Structured rectilinear and curvilinear grids are supported. .. _`xESMF`: https://xesmf.readthedocs.io/en/stable/ .. _`xgcm`: https://xgcm.readthedocs.io/en/latest/ -.. _`regrid2`: https://cdms.readthedocs.io/en/latest/regrid2.html +.. _`regrid2 package`: https://cdms.readthedocs.io/en/latest/regrid2.html How can I retrieve the grid from a dataset? ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/setup.py b/setup.py index 930448ea..36b4ada0 100755 --- a/setup.py +++ b/setup.py @@ -35,6 +35,6 @@ test_suite="tests", tests_require=test_requires, url="https://github.com/xCDAT/xcdat", - version="0.6.0rc1", + version="0.6.0", zip_safe=False, ) diff --git a/tbump.toml b/tbump.toml index b7dc8c9c..995b3db3 100644 --- a/tbump.toml +++ b/tbump.toml @@ -2,7 +2,7 @@ github_url = "https://github.com/xCDAT/xcdat" [version] -current = "0.6.0rc1" +current = "0.6.0" # Example of a semver regexp. # Make sure this matches current_version before diff --git a/xcdat/__init__.py b/xcdat/__init__.py index 39c183e2..d965cb46 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.6.0rc1" +__version__ = "0.6.0"