Skip to content

Commit 2325f29

Browse files
tomvothecodertomvothecoder
authored
Bump to v0.6.0 (#555)
* Add VS Code debugger config * Update changelog and fix FAQs link
1 parent bb1fff6 commit 2325f29

File tree

6 files changed

+118
-5
lines changed

6 files changed

+118
-5
lines changed

‎.vscode/xcdat.code-workspace

+22
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,9 @@
77
"path": ".."
88
}
99
],
10+
// ===========================
11+
// VS Code Workspace Settings
12+
// ===========================
1013
"settings": {
1114
// ===================
1215
// Editor settings
@@ -49,5 +52,24 @@
4952
"editor.wordWrap": "wordWrapColumn",
5053
"editor.wordWrapColumn": 120
5154
}
55+
},
56+
// =====================================
57+
// VS Code Python Debugger Configuration
58+
// =====================================
59+
"launch": {
60+
"version": "0.2.0",
61+
"configurations": [
62+
{
63+
"name": "Python: Current File",
64+
"type": "python",
65+
"request": "launch",
66+
"program": "${file}",
67+
"console": "integratedTerminal",
68+
"justMyCode": true,
69+
"env": {
70+
"PYTHONPATH": "${workspaceFolder}"
71+
}
72+
}
73+
]
5274
}
5375
}

‎HISTORY.rst

+91
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,97 @@
22
History
33
=======
44

5+
v0.6.0 (10 October 2023)
6+
------------------------
7+
8+
This minor version update consists of new features including vertical
9+
regridding (extension of ``xgcm``), functions for producing accurate
10+
time bounds, and improving the usability of the ``create_grid`` API. It
11+
also includes bug fixes to preserve attributes when using regrid2
12+
horizontal regridder and fixing multi-file datasets spatial average
13+
orientation and weights when lon bounds span prime meridian.
14+
15+
Features
16+
--------
17+
18+
- Functions to produce accurate time bounds by `Stephen Po-Chedley`_ in
19+
https://github.com/xCDAT/xcdat/pull/418
20+
- Add API extending xgcm vertical regridding by `Jason Boutte`_ in
21+
https://github.com/xCDAT/xcdat/pull/388,
22+
https://github.com/xCDAT/xcdat/pull/535,
23+
https://github.com/xCDAT/xcdat/pull/525
24+
- Update ``create_grid`` args to improve usability by `Jason Boutte`_ in
25+
https://github.com/xCDAT/xcdat/pull/507,
26+
https://github.com/xCDAT/xcdat/pull/539
27+
28+
Deprecation
29+
-----------
30+
31+
- Add deprecation warnings for ``add_bounds`` boolean args by
32+
`Tom Vo`_ in https://github.com/xCDAT/xcdat/pull/548,
33+
- Add deprecation warning for CDML/XML support in ``open_mfdataset()`` by `Tom Vo`_
34+
in https://github.com/xCDAT/xcdat/pull/503,
35+
https://github.com/xCDAT/xcdat/pull/504
36+
37+
Bug Fixes
38+
---------
39+
40+
Horizontal Regridding
41+
~~~~~~~~~~~~~~~~~~~~~
42+
43+
- Improves error when axis is missing/incorrect attributes with regrid2
44+
by `Jason Boutte`_ in https://github.com/xCDAT/xcdat/pull/481
45+
- Fixes preserving ds/da attributes in the regrid2 module by `Jason Boutte`_
46+
in https://github.com/xCDAT/xcdat/pull/468
47+
- Fixes duplicate parameter in regrid2 docs by `Jason Boutte`_ in
48+
https://github.com/xCDAT/xcdat/pull/532
49+
50+
Spatial Averaging
51+
~~~~~~~~~~~~~~~~~
52+
- Fix multi-file dataset spatial average orientation and weights when
53+
lon bounds span prime meridian by `Stephen Po-Chedley`_ in
54+
https://github.com/xCDAT/xcdat/pull/495
55+
56+
Documentation
57+
-------------
58+
59+
- Typo fix for climatology code example in docs by `Jiwoo Lee`_ in
60+
https://github.com/xCDAT/xcdat/pull/491
61+
- Update documentation in regrid2.py by `Jiwoo Lee`_ in
62+
https://github.com/xCDAT/xcdat/pull/509
63+
- Add more fields to GH Discussions question form by `Tom Vo`_ in
64+
https://github.com/xCDAT/xcdat/pull/480
65+
- Add Q&A GH discussions template by `Tom Vo`_ in
66+
https://github.com/xCDAT/xcdat/pull/479
67+
- Update FAQs question covering datasets with conflicting bounds by
68+
`Tom Vo`_ in https://github.com/xCDAT/xcdat/pull/474
69+
- Add Google Groups mailing list to docs by `Tom Vo`_ in
70+
https://github.com/xCDAT/xcdat/pull/452
71+
- Fix README link to CODE-OF-CONDUCT.rst by `Tom Vo`_ in
72+
https://github.com/xCDAT/xcdat/pull/444
73+
- Replace LLNL E3SM License with xCDAT License by `Tom Vo`_ in
74+
https://github.com/xCDAT/xcdat/pull/443
75+
- Update getting started and HPC documentation by `Tom Vo`_ in
76+
https://github.com/xCDAT/xcdat/pull/553
77+
78+
DevOps
79+
------
80+
81+
- Fix Python deprecation comment in conda env yml files by
82+
`Tom Vo`_ in https://github.com/xCDAT/xcdat/pull/514
83+
- Simplify conda environments and move configs to ``pyproject.toml`` by
84+
`Tom Vo`_ in https://github.com/xCDAT/xcdat/pull/512
85+
- Update DevOps to cache conda and fix attributes not being preserved
86+
with ``xarray > 2023.3.0`` by `Tom Vo`_ in
87+
https://github.com/xCDAT/xcdat/pull/465
88+
- Update GH Actions to use ``mamba`` by `Tom Vo`_ in
89+
https://github.com/xCDAT/xcdat/pull/450
90+
- Update constraint ``cf_xarray >=0.7.3`` to workaround xarray import
91+
issue by `Tom Vo`_ in https://github.com/xCDAT/xcdat/pull/547
92+
93+
**Full Changelog**: https://github.com/xCDAT/xcdat/compare/v0.5.0...v0.6.0
94+
95+
596
v0.5.0 (27 March 2023)
697
--------------------------
798

‎docs/faqs.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -228,13 +228,13 @@ For more information on these options, visit the `xarray.open_mfdataset`_ docume
228228

229229
Regridding
230230
----------
231-
``xcdat`` extends and provides a uniform interface to `xESMF`_ and `xgcm`_. In addition, ``xcdat`` provides a port of the ``CDAT`` `regrid2`_ package.
231+
``xcdat`` extends and provides a uniform interface to `xESMF`_ and `xgcm`_. In addition, ``xcdat`` provides a port of the ``CDAT`` `regrid2 package`_.
232232

233233
Structured rectilinear and curvilinear grids are supported.
234234

235235
.. _`xESMF`: https://xesmf.readthedocs.io/en/stable/
236236
.. _`xgcm`: https://xgcm.readthedocs.io/en/latest/
237-
.. _`regrid2`: https://cdms.readthedocs.io/en/latest/regrid2.html
237+
.. _`regrid2 package`: https://cdms.readthedocs.io/en/latest/regrid2.html
238238

239239
How can I retrieve the grid from a dataset?
240240
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

‎setup.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,6 @@
3535
test_suite="tests",
3636
tests_require=test_requires,
3737
url="https://github.com/xCDAT/xcdat",
38-
version="0.6.0rc1",
38+
version="0.6.0",
3939
zip_safe=False,
4040
)

‎tbump.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
github_url = "https://github.com/xCDAT/xcdat"
33

44
[version]
5-
current = "0.6.0rc1"
5+
current = "0.6.0"
66

77
# Example of a semver regexp.
88
# Make sure this matches current_version before

‎xcdat/__init__.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,4 +20,4 @@
2020
from xcdat.temporal import TemporalAccessor # noqa: F401
2121
from xcdat.utils import compare_datasets # noqa: F401
2222

23-
__version__ = "0.6.0rc1"
23+
__version__ = "0.6.0"

0 commit comments

Comments
 (0)