windspharm
is a Python package for computing quantities derived from global wind
fields using spherical harmonics, licensed under the MIT license.
windspharm
provides a user-friendly interface for vector wind computations on the
sphere (e.g., divergence, streamfunction etc.). windspharm
is based on the
pyspharm
module.
windspharm
provides a replacement for the windfield
package from CDAT (windfield
was based on the sphere
module, which is now deprecated).
windspharm
only requires numpy
and pyspharm
(version 1.0.8 or higher), but for full functionality (meta-data interfaces) either or both of the iris
module or the cdms2
module is required.
cdms2
is part of the Climate Data Analysis Tools (CDAT) or can be obtained separately in the cdat_lite package.
Documentation is available online. The package docstrings are also very complete and can be used as a source of reference when working interactively.
- Do I need CDAT/
cdms2
oriris
to usewindspharm
? No. All the computation code usesnumpy
only. Theiris
orcdms2
modules are only required for the meta-data preserving interfaces. - Is
windspharm
a drop in replacement forwindfield
? No. Becausewindspharm
was written from scratch the naming conventions for methods are different. Some new methods have been added compared towindfield
, and some methods fromwindfield
do not exist inwindspharm
.
python setup.py --user
to install in your home directory, or to install system wide if you have permissions:
sudo python setup.py install