Skip to content

Commit 870b334

Browse files
tomvothecodertomvothecoder
authored
Bump to 0.6.0rc1 (#515)
1 parent c2fd8fd commit 870b334

File tree

8 files changed

+61
-39
lines changed

8 files changed

+61
-39
lines changed

‎.github/workflows/build_workflow.yml

+13-11
Original file line numberDiff line numberDiff line change
@@ -24,17 +24,17 @@ jobs:
2424
cancel_others: ${{ env.CANCEL_OTHERS }}
2525
paths_ignore: ${{ env.PATHS_IGNORE }}
2626

27-
- if: ${{ steps.skip_check.outputs.should_skip != 'true' }}
27+
- if: ${{ steps.skip_check.outputs.should_skip == 'false' }}
2828
name: Checkout Code Repository
2929
uses: actions/checkout@v3
3030

31-
- if: ${{ steps.skip_check.outputs.should_skip != 'true' }}
31+
- if: ${{ steps.skip_check.outputs.should_skip == 'false' }}
3232
name: Set up Python 3.10
3333
uses: actions/setup-python@v3
3434
with:
3535
python-version: "3.10"
3636

37-
- if: ${{ steps.skip_check.outputs.should_skip != 'true' }}
37+
- if: ${{ steps.skip_check.outputs.should_skip == 'false' }}
3838
# Run all pre-commit hooks on all the files.
3939
# Getting only staged files can be tricky in case a new PR is opened
4040
# since the action is run on a branch in detached head state
@@ -59,10 +59,10 @@ jobs:
5959
paths_ignore: ${{ env.PATHS_IGNORE }}
6060
do_not_skip: '["push", "workflow_dispatch"]'
6161

62-
- if: ${{ steps.skip_check.outputs.should_skip != 'true' }}
62+
- if: ${{ steps.skip_check.outputs.should_skip == 'false' }}
6363
uses: actions/checkout@v3
6464

65-
- if: ${{ steps.skip_check.outputs.should_skip != 'true' }}
65+
- if: ${{ steps.skip_check.outputs.should_skip == 'false' }}
6666
name: Set up Conda Environment
6767
uses: conda-incubator/setup-miniconda@v2
6868
with:
@@ -77,13 +77,13 @@ jobs:
7777

7878
# Refresh the cache every 24 hours to avoid inconsistencies of package versions
7979
# between the CI pipeline and local installations.
80-
- if: ${{ steps.skip_check.outputs.should_skip != 'true' }}
80+
- if: ${{ steps.skip_check.outputs.should_skip == 'false' }}
8181
id: get-date
8282
name: Get Date
8383
run: echo "today=$(/bin/date -u '+%Y%m%d')" >> $GITHUB_OUTPUT
8484
shell: bash
8585

86-
- if: ${{ steps.skip_check.outputs.should_skip != 'true' }}
86+
- if: ${{ steps.skip_check.outputs.should_skip == 'false' }}
8787
id: cache
8888
name: Cache Conda env
8989
uses: actions/cache@v3
@@ -96,25 +96,27 @@ jobs:
9696
# Increase this value to reset cache if conda-env/ci.yml has not changed in the workflow
9797
CACHE_NUMBER: 0
9898

99-
- if: $${{ steps.skip_check.outputs.should_skip != 'true' || steps.cache.outputs.cache-hit != 'true' }}
99+
- if: |
100+
steps.skip_check.outputs.should_skip == 'false' &&
101+
steps.cache.outputs.cache-hit == 'false'
100102
name: Update environment
101103
run: |
102104
mamba env update -n xcdat_ci -f conda-env/ci.yml
103105
# Make sure the Python version in the env matches the current matrix version.
104106
mamba install -c conda-forge python=${{ matrix.python-version }}
105107
106-
- if: ${{ steps.skip_check.outputs.should_skip != 'true' }}
108+
- if: ${{ steps.skip_check.outputs.should_skip == 'false' }}
107109
name: Install xcdat
108110
# Source: https://github.com/conda/conda-build/issues/4251#issuecomment-1053460542
109111
run: |
110112
python -m pip install --no-build-isolation --no-deps -e .
111113
112-
- if: ${{ steps.skip_check.outputs.should_skip != 'true' }}
114+
- if: ${{ steps.skip_check.outputs.should_skip == 'false' }}
113115
name: Run Tests
114116
run: |
115117
pytest
116118
117-
- if: ${{ steps.skip_check.outputs.should_skip != 'true' }}
119+
- if: ${{ steps.skip_check.outputs.should_skip == 'false' }}
118120
name: Upload Coverage Report
119121
uses: codecov/codecov-action@v3
120122
with:

‎README.rst

+19-9
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ robust analysis of climate data. xCDAT's design philosophy is focused on reducin
7070
overhead required to accomplish certain tasks in xarray. xCDAT aims to be compatible
7171
with structured grids that are `CF-compliant`_ (e.g., CMIP6). Some key xCDAT features
7272
are inspired by or ported from the core CDAT library, while others leverage powerful
73-
libraries in the xarray ecosystem (e.g., `xESMF`_ and `cf_xarray`_) to deliver
73+
libraries in the xarray ecosystem (e.g., `xESMF`_, `xgcm`_, `cf_xarray`_) to deliver
7474
robust APIs.
7575

7676
The xCDAT core team's mission is to provide a maintainable and extensible package
@@ -123,8 +123,8 @@ For more instructions on how to contribute, please checkout our `Contributing Gu
123123
.. _GitHub Issue Tracker: https://github.com/xCDAT/xcdat/issues
124124
.. _Contributing Guide: https://xcdat.readthedocs.io/en/stable/contributing.html
125125

126-
Available Features
127-
------------------
126+
Features
127+
--------
128128

129129
* Extension of xarray's ``open_dataset()`` and ``open_mfdataset()`` with post-processing options
130130

@@ -153,15 +153,13 @@ Available Features
153153
* Horizontal structured regridding
154154

155155
* Supports rectilinear and curvilinear grids
156-
* Python implementation of `regrid2`_ for handling cartesian latitude longitude grids
157-
* API that wraps `xESMF`_
158-
159-
Planned Features
160-
----------------
156+
* Extends the `xESMF`_ horizontal regridding API
157+
* Python implementation of `regrid2`_ for handling cartesian latitude longitude grids
161158

162159
* Vertical structured regridding
163160

164161
* Support rectilinear and curvilinear grids
162+
* Extends the `xgcm`_ vertical regridding API
165163

166164
Things We Are Striving For
167165
--------------------------
@@ -184,8 +182,9 @@ Things We Are Striving For
184182
* Support for parallelism using `dask`_ where it is both possible and makes sense
185183

186184
.. _Metadata Interpretation: https://xcdat.readthedocs.io/en/stable/faqs.html#metadata-interpretation
187-
.. _regrid2: https://cdms.readthedocs.io/en/latest/regrid2.html
188185
.. _xESMF: https://pangeo-xesmf.readthedocs.io/en/latest/
186+
.. _regrid2: https://cdms.readthedocs.io/en/latest/regrid2.html
187+
.. _xgcm: https://xgcm.readthedocs.io/en/latest/index.html
189188
.. _dask: https://dask.org/
190189
.. _cf_xarray: https://cf-xarray.readthedocs.io/en/latest/index.html
191190
.. _CF convention: http://cfconventions.org/
@@ -205,6 +204,17 @@ Subscribe to our `mailing list`_ to stay notified of new releases.
205204
.. _conda-forge: https://anaconda.org/conda-forge/xcdat
206205
.. _GitHub Releases: https://anaconda.org/conda-forge/xcdat
207206

207+
Useful Resources
208+
-----------------
209+
210+
We highly encourage you to checkout the awesome resources below to learn more about
211+
Xarray and Xarray usage in climate science!
212+
213+
- `Official Xarray Tutorials <https://tutorial.xarray.dev/intro.html>`_
214+
- `Xarray GitHub Discussion Forum <https://github.com/pydata/xarray/discussions>`_
215+
- `Pangeo Forum <https://foundations.projectpythia.org/core/xarray.html>`_
216+
- `Project Pythia <https://foundations.projectpythia.org/core/xarray.html>`_
217+
208218
Acknowledgement
209219
---------------
210220

‎docs/index.rst

+19-9
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ robust analysis of climate data. xCDAT's design philosophy is focused on reducin
2020
overhead required to accomplish certain tasks in xarray. xCDAT aims to be compatible
2121
with structured grids that are `CF-compliant`_ (e.g., CMIP6). Some key xCDAT features
2222
are inspired by or ported from the core CDAT library, while others leverage powerful
23-
libraries in the xarray ecosystem (e.g., `xESMF`_ and `cf_xarray`_) to deliver
23+
libraries in the xarray ecosystem (e.g., `xESMF`_, `xgcm`_, `cf_xarray`_) to deliver
2424
robust APIs.
2525

2626
The xCDAT core team's mission is to provide a maintainable and extensible package
@@ -73,8 +73,8 @@ For more instructions on how to contribute, please checkout our `Contributing Gu
7373
.. _GitHub Issue Tracker: https://github.com/xCDAT/xcdat/issues
7474
.. _Contributing Guide: https://xcdat.readthedocs.io/en/stable/contributing.html
7575

76-
Available Features
77-
------------------
76+
Features
77+
--------
7878

7979
* Extension of xarray's ``open_dataset()`` and ``open_mfdataset()`` with post-processing options
8080

@@ -103,15 +103,13 @@ Available Features
103103
* Horizontal structured regridding
104104

105105
* Supports rectilinear and curvilinear grids
106-
* Python implementation of `regrid2`_ for handling cartesian latitude longitude grids
107-
* API that wraps `xESMF`_
108-
109-
Planned Features
110-
----------------
106+
* Extends the `xESMF`_ horizontal regridding API
107+
* Python implementation of `regrid2`_ for handling cartesian latitude longitude grids
111108

112109
* Vertical structured regridding
113110

114111
* Support rectilinear and curvilinear grids
112+
* Extends the `xgcm`_ vertical regridding API
115113

116114
Things We Are Striving For
117115
--------------------------
@@ -134,8 +132,9 @@ Things We Are Striving For
134132
* Support for parallelism using `dask`_ where it is both possible and makes sense
135133

136134
.. _Metadata Interpretation: https://xcdat.readthedocs.io/en/stable/faqs.html#metadata-interpretation
137-
.. _regrid2: https://cdms.readthedocs.io/en/latest/regrid2.html
138135
.. _xESMF: https://pangeo-xesmf.readthedocs.io/en/latest/
136+
.. _regrid2: https://cdms.readthedocs.io/en/latest/regrid2.html
137+
.. _xgcm: https://xgcm.readthedocs.io/en/latest/index.html
139138
.. _dask: https://dask.org/
140139
.. _cf_xarray: https://cf-xarray.readthedocs.io/en/latest/index.html
141140
.. _CF convention: http://cfconventions.org/
@@ -155,6 +154,17 @@ Subscribe to our `mailing list`_ to stay notified of new releases.
155154
.. _conda-forge: https://anaconda.org/conda-forge/xcdat
156155
.. _GitHub Releases: https://anaconda.org/conda-forge/xcdat
157156

157+
Useful Resources
158+
-----------------
159+
160+
We highly encourage you to checkout the awesome resources below to learn more about
161+
Xarray and Xarray usage in climate science!
162+
163+
- `Official Xarray Tutorials <https://tutorial.xarray.dev/intro.html>`_
164+
- `Xarray GitHub Discussion Forum <https://github.com/pydata/xarray/discussions>`_
165+
- `Pangeo Forum <https://foundations.projectpythia.org/core/xarray.html>`_
166+
- `Project Pythia <https://foundations.projectpythia.org/core/xarray.html>`_
167+
158168
Acknowledgement
159169
---------------
160170

‎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.5.0",
38+
version="0.6.0rc1",
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.5.0"
5+
current = "0.6.0rc1"
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.5.0"
23+
__version__ = "0.6.0rc1"

‎xcdat/bounds.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -244,8 +244,8 @@ def get_bounds(
244244
f"No bounds data variables were found for the '{axis}' axis. Make sure "
245245
"the dataset has bound data vars and their names match the 'bounds' "
246246
"attributes found on their related time coordinate variables. "
247-
"Alternatively, you can add bounds with `xcdat.add_missing_bounds` "
248-
"or `xcdat.add_bounds`."
247+
"Alternatively, you can add bounds with `ds.bounds.add_missing_bounds()` "
248+
"or `ds.bounds.add_bounds()`."
249249
)
250250

251251
bounds: Union[xr.Dataset, xr.DataArray] = self._dataset[

‎xcdat/temporal.py

+5-5
Original file line numberDiff line numberDiff line change
@@ -290,7 +290,7 @@ def group_average(
290290
>>> custom_seasons = [
291291
>>> ["Jan", "Feb", "Mar"], # "JanFebMar"
292292
>>> ["Apr", "May", "Jun"], # "AprMayJun"
293-
>>> ["Jul", "Aug", "Sep"], # "JunJulAug"
293+
>>> ["Jul", "Aug", "Sep"], # "JulAugSep"
294294
>>> ["Oct", "Nov", "Dec"], # "OctNovDec"
295295
>>> ]
296296
@@ -326,7 +326,7 @@ def group_average(
326326
>>> custom_seasons = [
327327
>>> ["Jan", "Feb", "Mar"], # "JanFebMar"
328328
>>> ["Apr", "May", "Jun"], # "AprMayJun"
329-
>>> ["Jul", "Aug", "Sep"], # "JunJulAug"
329+
>>> ["Jul", "Aug", "Sep"], # "JulAugSep"
330330
>>> ["Oct", "Nov", "Dec"], # "OctNovDec"
331331
>>> ]
332332
>>>
@@ -445,7 +445,7 @@ def climatology(
445445
>>> custom_seasons = [
446446
>>> ["Jan", "Feb", "Mar"], # "JanFebMar"
447447
>>> ["Apr", "May", "Jun"], # "AprMayJun"
448-
>>> ["Jul", "Aug", "Sep"], # "JunJulAug"
448+
>>> ["Jul", "Aug", "Sep"], # "JulAugSep"
449449
>>> ["Oct", "Nov", "Dec"], # "OctNovDec"
450450
>>> ]
451451
@@ -485,7 +485,7 @@ def climatology(
485485
>>> custom_seasons = [
486486
>>> ["Jan", "Feb", "Mar"], # "JanFebMar"
487487
>>> ["Apr", "May", "Jun"], # "AprMayJun"
488-
>>> ["Jul", "Aug", "Sep"], # "JunJulAug"
488+
>>> ["Jul", "Aug", "Sep"], # "JulAugSep"
489489
>>> ["Oct", "Nov", "Dec"], # "OctNovDec"
490490
>>> ]
491491
>>>
@@ -614,7 +614,7 @@ def departures(
614614
>>> custom_seasons = [
615615
>>> ["Jan", "Feb", "Mar"], # "JanFebMar"
616616
>>> ["Apr", "May", "Jun"], # "AprMayJun"
617-
>>> ["Jul", "Aug", "Sep"], # "JunJulAug"
617+
>>> ["Jul", "Aug", "Sep"], # "JulAugSep"
618618
>>> ["Oct", "Nov", "Dec"], # "OctNovDec"
619619
>>> ]
620620

0 commit comments

Comments
 (0)