Skip to content

Commit

Permalink
Remove the cdms interface
Browse files Browse the repository at this point in the history
  • Loading branch information
ajdawson committed Nov 20, 2024
1 parent 66b0b5d commit 6bcbc22
Show file tree
Hide file tree
Showing 12 changed files with 22 additions and 1,146 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,7 @@ windspharm provides a replacement for the windfield package from CDAT.
Requirements
------------

`windspharm` only requires [`numpy`](http://numpy.org) and [`pyspharm`](https://github.com/jswhit/pyspharm) (version 1.0.8 or higher), but for full functionality (meta-data interfaces) one or more of [`iris`](http://scitools.org.uk/iris/), [`xarray`](http://xarray.pydata.org) or the `cdms2` module (from [UV-CDAT](http://uvcdat.llnl.gov) is required.
The setuptools package is required for installation.
windspharm runs on Python 2 and 3.
`windspharm` only requires [`numpy`](http://numpy.org) and [`pyspharm`](https://github.com/jswhit/pyspharm) (version 1.0.9 or higher), but for full functionality (meta-data interfaces) one or both of [`iris`](http://scitools.org.uk/iris/) and/or [`xarray`](http://xarray.pydata.org) are required.


Documentation
Expand All @@ -39,8 +37,8 @@ You can additionally cite the [Zenodo DOI](https://zenodo.org/badge/latestdoi/20
Frequently asked questions
--------------------------

* **Do I need UV-CDAT/iris/xarray to use windspharm?**
No. All the computation code uses numpy only. The iris, xarray and cdms2 modules are only required for the meta-data preserving interfaces.
* **Do I need iris/xarray to use windspharm?**
No. All the computation code uses numpy only. The iris and/or xarray modules are only required for the meta-data preserving interfaces.
* **Is windspharm a drop in replacement for windfield?**
No. Because windspharm was written from scratch the naming conventions for methods
are different. Some new methods have been added compared to windfield, and some
Expand All @@ -54,7 +52,9 @@ The easiest way to install is via [conda](http://conda.pydata.org):

conda install -c conda-forge windspharm

You can also install from the source distribution.
Download the archive, unpack it, then enter the source directory and use:
You can also install with pip::

python setup.py install
python -m pip install windspharm

> [!CAUTION]
> Make sure you already have pyspharm dependency installed, as it may fail to install if pip tries to do it.
8 changes: 8 additions & 0 deletions docs/changelog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,14 @@ Changelog

Source code downloads for released versions can be downloaded from `Github <https://github.com/ajdawson/windspharm/releases>`_.

v2.0
----

:Release: v2.0.0

The v2.0.0 release removes the cdms interface. The cdms2 package is no longer maintained and therefore support has been dropped.


v1.7
----

Expand Down
60 changes: 0 additions & 60 deletions examples/cdms/rws_example.py

This file was deleted.

69 changes: 0 additions & 69 deletions examples/cdms/sfvp_example.py

This file was deleted.

5 changes: 2 additions & 3 deletions examples/standard/rws_example.py
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,8 @@
mpl.rcParams['mathtext.default'] = 'regular'


# Read zonal and meridional wind components from file using the cdms2 module
# from CDAT. The components are defined on pressure levels and are in separate
# files.
# Read zonal and meridional wind component, the components are defined on
# pressure levels and are in separate files.
ncu = Dataset(example_data_path('uwnd_mean.nc'), 'r')
uwnd = ncu.variables['uwnd'][:]
lons = ncu.variables['longitude'][:]
Expand Down
7 changes: 0 additions & 7 deletions windspharm/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -32,13 +32,6 @@
# from windspharm import *
__all__ = []

try:
from . import cdms
__all__.append('cdms')
metadata = cdms
except ImportError:
pass

try:
from . import iris
__all__.append('iris')
Expand Down
Loading

0 comments on commit 6bcbc22

Please sign in to comment.