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.). It is based on the
pyspharm module.
windspharm provides a replacement for the windfield package from CDAT.
windspharm only requires numpy and pyspharm (version 1.0.9 or higher), but for full functionality (meta-data interfaces) one or both of iris and/or xarray are required.
Documentation is available online. The package docstrings are also very complete and can be used as a source of reference when working interactively.
If you use windspharm in published research, please cite it by referencing the peer-reviewed paper. You can additionally cite the Zenodo DOI if you need to cite a particular version (but please also cite the paper, it helps me justify my time working on this and similar projects).
- 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 methods from windfield do not exist in windspharm.
The easiest way to install is via conda:
conda install -c conda-forge windspharm
You can also install with pip::
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.