Bump to v0.5.0 (#436)

xCDAT · Mar 27, 2023 · d0a4892 · d0a4892
1 parent fc18ccc
commit d0a4892
Show file tree

Hide file tree

Showing 9 changed files with 100 additions and 42 deletions.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -11,7 +11,7 @@ repos:
           - id: check-yaml
 
     - repo: https://github.com/psf/black
-      rev: 22.12.0
+      rev: 23.1.0
       hooks:
           - id: black
 
@@ -30,15 +30,15 @@ repos:
             additional_dependencies: [flake8-isort]
 
     - repo: https://github.com/pre-commit/mirrors-mypy
-      rev: v0.990
+      rev: v1.1.1
       hooks:
           - id: mypy
             args: ["--config=setup.cfg"]
             additional_dependencies:
                 [
-                    dask==2022.10.2,
+                    dask==2023.3.2,
                     numpy==1.23.5,
                     pandas==1.5.3,
-                    xarray==2023.1.0,
+                    xarray==2023.3.0,
                     types-python-dateutil==2.8.19,
                 ]
diff --git a/HISTORY.rst b/HISTORY.rst
@@ -2,6 +2,61 @@
 History
 =======
 
+v0.5.0 (27 March 2023)
+--------------------------
+
+This long-awaited minor release includes feature updates to support an
+optional user-specified climatology reference period when calculating
+climatologies and departures, support for opening datasets using the
+``directory`` key of the legacy CDAT `Climate Data Markup Language
+(CDML) <https://cdms.readthedocs.io/en/latest/manual/cdms_6.html>`__
+format (an XML dialect), and improved support for using custom time
+coordinates in temporal APIs.
+
+This release also includes a bug fix for singleton coordinates breaking
+the ``swap_lon_axis()`` function. Additionally, Jupyter Notebooks for
+presentations and demos have been added to the documentation.
+
+Features
+~~~~~~~~
+
+-  Update departures and climatology APIs with reference period by
+   `Tom Vo`_ in https://github.com/xCDAT/xcdat/pull/417
+-  Wrap open_dataset and open_mfdataset to flexibly open datasets by
+   `Stephen Po-Chedley`_ in https://github.com/xCDAT/xcdat/pull/385
+-  Add better support for using custom time coordinates in temporal APIs
+   by `Tom Vo`_ in https://github.com/xCDAT/xcdat/pull/415
+
+Bug Fixes
+~~~~~~~~~
+
+-  Raise warning if no time coords found with ``decode_times`` by
+   `Tom Vo`_ in https://github.com/xCDAT/xcdat/pull/409
+-  Bump conda env dependencies by `Tom Vo`_ in
+   https://github.com/xCDAT/xcdat/pull/408
+-  Fix ``swap_lon_axis()`` breaking when sorting with singleton coords
+   by `Tom Vo`_ in https://github.com/xCDAT/xcdat/pull/392
+
+Documentation
+~~~~~~~~~~~~~
+
+-  Update xsearch-xcdat-example.ipynb by `Stephen Po-Chedley`_ in
+   https://github.com/xCDAT/xcdat/pull/425
+-  Updates xesmf docs by `Jason Boutte`_ in
+   https://github.com/xCDAT/xcdat/pull/432
+-  Add presentations and demos to sphinx toctree by `Tom Vo`_ in
+   https://github.com/xCDAT/xcdat/pull/422
+-  Update temporal ``.average`` and ``.departures`` docstrings by
+   `Tom Vo`_ in https://github.com/xCDAT/xcdat/pull/407
+
+DevOps
+~~~~~~
+
+-  Bump conda env dependencies by `Tom Vo`_ in
+   https://github.com/xCDAT/xcdat/pull/408
+
+**Full Changelog**: https://github.com/xCDAT/xcdat/compare/v0.4.0...v0.5.0
+
 v0.4.0 (9 November 2022)
 --------------------------
 

diff --git a/conda-env/ci.yml b/conda-env/ci.yml
@@ -17,9 +17,11 @@ dependencies:
     - netcdf4
     - numpy
     - pandas
+    - python-dateutil
     - xarray
     - xesmf
-    - python-dateutil
+    # Quality Assurance
+    # ==================
     - types-python-dateutil
     # Testing
     # ==================

diff --git a/conda-env/dev.yml b/conda-env/dev.yml
@@ -8,52 +8,52 @@ dependencies:
     # Base
     # ==================
     # NOTE: If versions are updated, also `additional_dependencies` list for mypy in `.pre-commit-config.yaml`
-    - python=3.10.8
-    - pip=22.3.1
-    - cf_xarray=0.7.7
+    - python=3.10.10
+    - pip=23.0.1
+    - cf_xarray=0.8.0
     - cftime=1.6.2
-    - dask=2023.1.0
+    - dask=2023.3.2
     - lxml=4.9.2
-    - netcdf4=1.6.2
+    - netcdf4=1.6.3
     - numpy=1.23.5
     - pandas=1.5.3
     - python-dateutil=2.8.2
-    - xarray=2023.1.0
+    - xarray=2023.3.0
     # ==================
     # Optional
     # ==================
     - xesmf=0.7.0
-    - matplotlib=3.6.3
+    - matplotlib-base=3.7.1
     - nc-time-axis=1.4.1
     # ==================
     # Documentation
     # ==================
-    - sphinx=4.5.0
+    - sphinx=5.3.0
     - sphinx-autosummary-accessors=2022.4.0
-    - sphinx-book-theme=0.3.3
-    - sphinx-copybutton=0.5.0
-    - nbsphinx=0.8.12
-    - pandoc=2.19.2
-    - ipython=8.8.0 # Required for nbsphinx syntax highlighting
+    - sphinx-book-theme=1.0.0
+    - sphinx-copybutton=0.5.1
+    - nbsphinx=0.9.1
+    - pandoc=3.1.1
+    - ipython=8.11.0 # Required for nbsphinx syntax highlighting
     # ==================
     # Quality Assurance
     # ==================
     # NOTE: If versions are updated, also update 'rev' in `.pre-commit.config.yaml`
-    - black=22.12.0
+    - black=23.1.0
     - flake8=6.0.0
     - flake8-isort=6.0.0
     - isort=5.12.0
-    - mypy=0.991
-    - pre-commit=2.21.0
+    - mypy=1.1.1
+    - pre-commit=3.2.0
     - types-python-dateutil=2.8.19
     # ==================
     # Testing
     # ==================
-    - pytest=7.2.1
+    - pytest=7.2.2
     - pytest-cov=4.0.0
     # ==================
     # Developer Tools
     # ==================
-    - jupyterlab=3.5.3
+    - jupyterlab=3.6.2
     - tbump=6.9.0
 prefix: /opt/miniconda3/envs/xcdat_dev
diff --git a/conda-env/readthedocs.yml b/conda-env/readthedocs.yml
@@ -7,32 +7,34 @@ dependencies:
     # Base
     # ==================
     # NOTE: If versions are updated, also `additional_dependencies` list for mypy in `.pre-commit-config.yaml`
-    - python=3.10.8
-    - pip=22.3.1
-    - cf_xarray=0.7.7
+    - python=3.10.10
+    - pip=23.0.1
+    - cf_xarray=0.8.0
     - cftime=1.6.2
-    - dask=2023.1.0
+    - dask=2023.3.2
     - lxml=4.9.2
-    - netcdf4=1.6.2
+    - netcdf4=1.6.3
     - numpy=1.23.5
     - pandas=1.5.3
     - python-dateutil=2.8.2
-    - xarray=2023.1.0
+    - xarray=2023.3.0
     # ==================
     # Optional
     # ==================
     - xesmf=0.7.0
+    - matplotlib-base=3.7.1
+    - nc-time-axis=1.4.1
     # ==================
-    # Quality Assurance
-    # ==================
-    - types-python-dateutil=2.8.19
     # Documentation
     # ==================
-    - sphinx=4.5.0
+    - sphinx=5.3.0
     - sphinx-autosummary-accessors=2022.4.0
-    - sphinx-book-theme=0.3.3
-    - sphinx-copybutton=0.5.0
-    - nbsphinx=0.8.12
-    - pandoc=2.19.2
-    - ipython=8.8.0 # Required for nbsphinx syntax highlighting.
+    - sphinx-book-theme=1.0.0
+    - sphinx-copybutton=0.5.1
+    - nbsphinx=0.9.1
+    - pandoc=3.1.1
+    - ipython=8.11.0 # Required for nbsphinx syntax highlighting
+    # Quality Assurance
+    # ==================
+    - types-python-dateutil=2.8.19
 prefix: /opt/miniconda3/envs/xcdat_rtd
diff --git a/docs/conf.py b/docs/conf.py
@@ -146,7 +146,6 @@
     "use_issues_button": True,
     "use_download_button": True,
     "use_fullscreen_button": True,
-    "logo_only": True,
 }
 
 # Add any paths that contain custom static files (such as style sheets) here,

diff --git 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.4.0",
+    version="0.5.0",
     zip_safe=False,
 )
diff --git a/tbump.toml b/tbump.toml
@@ -2,7 +2,7 @@
 github_url = "https://github.com/xCDAT/xcdat"
 
 [version]
-current = "0.4.0"
+current = "0.5.0"
 
 # Example of a semver regexp.
 # Make sure this matches current_version before

diff --git a/xcdat/__init__.py b/xcdat/__init__.py
@@ -19,4 +19,4 @@
 from xcdat.temporal import TemporalAccessor  # noqa: F401
 from xcdat.utils import compare_datasets  # noqa: F401
 
-__version__ = "0.4.0"
+__version__ = "0.5.0"