windspharm - GitLite

KO | EN

gitlite — search

#javascript #react #llm #go #golang #android #machine-learning #linux #docker #awesome #awesome-list #pytorch #mcp #ios

windspharm

(★ 100)

A Python library for spherical harmonic computations on vector winds.

File Explorer

Download Latest Version (.zip)

- - deploy-docs.yml
  - pypi.yml
  - tests-standard.yml
  - tests.yml
- dependabot.yml
- - headerimage.png
  - logo.png
- - layout.html
  - sidebar_toc.html
- - index.rst
  - windspharm.iris.rst
  - windspharm.standard.rst
  - windspharm.tools.rst
  - windspharm.xarray.rst
- - index.rst
  - testing.rst
- - index.rst
  - iris_examples_index.rst
  - rws_iris.rst
  - rws_standard.rst
  - rws_xarray.rst
  - sfvp_iris.rst
  - sfvp_standard.rst
  - sfvp_xarray.rst
  - standard_examples_index.rst
  - xarray_examples_index.rst
- - index.rst
  - interfaces.rst
  - overview.rst
  - usage.rst
- changelog.rst
- conf.py
- example_code
- index.rst
- Makefile
- - rws_example.py
  - sfvp_example.py
- - rws_example.py
  - sfvp_example.py
- - rws_example.py
  - sfvp_example.py
- - __init__.py
- - __init__.py
  - reference.py
  - test_description.txt
  - test_error_handling.py
  - test_solution.py
  - test_tools.py
  - utils.py
- __init__.py
- _common.py
- iris.py
- standard.py
- tools.py
- xarray.py
.gitignore
.pre-commit-config.yaml
license.txt
MANIFEST.in
pyproject.toml
README.md

# Installation Guide

1. Get the code

git clone https://github.com/ajdawson/windspharm

Downloads the entire project code from GitHub to your computer.

cd windspharm

Moves into the project folder you just downloaded.

2. Python

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.

python -m pip install windspharm

Installs the Python libraries listed in requirements.txt (or similar).

✅ If it runs without errors and prints output in the terminal, it worked.

Pulled directly from this repo's README.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

windspharm - spherical harmonic vector wind analysis in Python
==============================================================

[![DOI (paper)](https://img.shields.io/badge/DOI%20%28paper%29-10.5334%2Fjors.129-blue.svg)](https://doi.org/10.5334/jors.129) [![DOI (latest release)](https://zenodo.org/badge/4715033.svg)](https://zenodo.org/records/1401190)

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`](https://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`](https://scitools-iris.readthedocs.io/) and/or [`xarray`](https://docs.xarray.dev) are required.

Documentation
-------------

Documentation is available [online](https://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](https://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 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.

Installation
------------

The easiest way to install is via [conda](https://docs.conda.io):

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.