windspharm - spherical harmonic vector wind analysis in Python
==============================================================
[](https://travis-ci.org/ajdawson/windspharm) [](http://doi.org/10.5334/jors.129) [](https://zenodo.org/badge/latestdoi/20448/ajdawson/windspharm)
Overview
--------
`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](https://github.com/jswhit/pyspharm) module.
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.
Documentation
-------------
Documentation is available [online](http://ajdawson.github.io/windspharm).
The package docstrings are also very complete and can be used as a source of reference when working interactively.
Citation
--------
If you use windspharm in published research, please cite it by referencing the [peer-reviewed paper](http://doi.org/10.5334/jors.129).
You can additionally cite the [Zenodo DOI](https://zenodo.org/badge/latestdoi/20448/ajdawson/windspharm) 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).
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.
* **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.
Installation
------------
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:
python setup.py install
Raw data
{
"_id": null,
"home_page": "http://ajdawson.github.com/windspharm/",
"name": "windspharm-syl",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "Andrew Dawson",
"author_email": "dawson@atm.ox.ac.uk",
"download_url": "https://files.pythonhosted.org/packages/a8/91/1836442bf830ac673a6d7b3f1c3a85ea7ce7a9fa98b9ee85c2a85650641e/windspharm-syl-1.7.0.tar.gz",
"platform": null,
"description": "windspharm - spherical harmonic vector wind analysis in Python\r\n==============================================================\r\n\r\n[](https://travis-ci.org/ajdawson/windspharm) [](http://doi.org/10.5334/jors.129) [](https://zenodo.org/badge/latestdoi/20448/ajdawson/windspharm)\r\n\r\nOverview\r\n--------\r\n\r\n`windspharm` is a Python package for computing quantities derived from global wind\r\nfields using spherical harmonics, licensed under the MIT license.\r\nwindspharm provides a user-friendly interface for vector wind computations on the\r\nsphere (e.g., divergence, streamfunction etc.). It is based on the\r\n[pyspharm](https://github.com/jswhit/pyspharm) module.\r\nwindspharm provides a replacement for the windfield package from CDAT.\r\n\r\n\r\nRequirements\r\n------------\r\n\r\n`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.\r\nThe setuptools package is required for installation.\r\nwindspharm runs on Python 2 and 3.\r\n\r\n\r\nDocumentation\r\n-------------\r\n\r\nDocumentation is available [online](http://ajdawson.github.io/windspharm).\r\nThe package docstrings are also very complete and can be used as a source of reference when working interactively.\r\n\r\n\r\nCitation\r\n--------\r\n\r\nIf you use windspharm in published research, please cite it by referencing the [peer-reviewed paper](http://doi.org/10.5334/jors.129).\r\nYou can additionally cite the [Zenodo DOI](https://zenodo.org/badge/latestdoi/20448/ajdawson/windspharm) 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).\r\n\r\n\r\nFrequently asked questions\r\n--------------------------\r\n\r\n* **Do I need UV-CDAT/iris/xarray to use windspharm?**\r\n No. All the computation code uses numpy only. The iris, xarray and cdms2 modules are only required for the meta-data preserving interfaces.\r\n* **Is windspharm a drop in replacement for windfield?**\r\n No. Because windspharm was written from scratch the naming conventions for methods\r\n are different. Some new methods have been added compared to windfield, and some\r\n methods from windfield do not exist in windspharm.\r\n\r\n\r\nInstallation\r\n------------\r\n\r\nThe easiest way to install is via [conda](http://conda.pydata.org):\r\n\r\n conda install -c conda-forge windspharm\r\n\r\nYou can also install from the source distribution.\r\nDownload the archive, unpack it, then enter the source directory and use:\r\n\r\n python setup.py install\r\n",
"bugtrack_url": null,
"license": "",
"summary": "vector wind analysis in spherical coordinates",
"version": "1.7.0",
"project_urls": {
"Homepage": "http://ajdawson.github.com/windspharm/"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "020bc204aadff9ac19546f6dd697bc0ab585d52a3e73d9fd6b394fb0e3c5cd7e",
"md5": "5dbe417f7b6750f72205e7089071f466",
"sha256": "e65b5fc720e3d03015ea4ff0d0f9e6a06ae6410a0c8c9ebba307da21d250b8ac"
},
"downloads": -1,
"filename": "windspharm_syl-1.7.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5dbe417f7b6750f72205e7089071f466",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 1956547,
"upload_time": "2024-01-01T05:41:46",
"upload_time_iso_8601": "2024-01-01T05:41:46.328679Z",
"url": "https://files.pythonhosted.org/packages/02/0b/c204aadff9ac19546f6dd697bc0ab585d52a3e73d9fd6b394fb0e3c5cd7e/windspharm_syl-1.7.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a8911836442bf830ac673a6d7b3f1c3a85ea7ce7a9fa98b9ee85c2a85650641e",
"md5": "ddef327165321878f267b3b8e9198cfc",
"sha256": "bca7b6132e63f0f4736401a70417704cc5fdc254f4b4ea1d1b3522c1f3c6cd8f"
},
"downloads": -1,
"filename": "windspharm-syl-1.7.0.tar.gz",
"has_sig": false,
"md5_digest": "ddef327165321878f267b3b8e9198cfc",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 1967542,
"upload_time": "2024-01-01T05:41:51",
"upload_time_iso_8601": "2024-01-01T05:41:51.349027Z",
"url": "https://files.pythonhosted.org/packages/a8/91/1836442bf830ac673a6d7b3f1c3a85ea7ce7a9fa98b9ee85c2a85650641e/windspharm-syl-1.7.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-01 05:41:51",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "windspharm-syl"
}
JSON