Skip to content

Commit

Permalink
Bump to v0.6.0 (#555)
Browse files Browse the repository at this point in the history
* Add VS Code debugger config
* Update changelog and fix FAQs link
  • Loading branch information
tomvothecoder committed Oct 10, 2023
1 parent bb1fff6 commit 2325f29
Show file tree
Hide file tree
Showing 6 changed files with 118 additions and 5 deletions.
22 changes: 22 additions & 0 deletions .vscode/xcdat.code-workspace
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@
"path": ".."
}
],
// ===========================
// VS Code Workspace Settings
// ===========================
"settings": {
// ===================
// Editor settings
Expand Down Expand Up @@ -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}"
}
}
]
}
}
91 changes: 91 additions & 0 deletions HISTORY.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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)
--------------------------

Expand Down
4 changes: 2 additions & 2 deletions docs/faqs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -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,
)
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.6.0rc1"
current = "0.6.0"

# 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.6.0rc1"
__version__ = "0.6.0"

0 comments on commit 2325f29

Please sign in to comment.