README.md
August 4, 2021 ยท View on GitHub
About
The module pyvortex consists of functions to calculate the equivalent latitude and edge of a polar vortex using Nash criteria.
Installation
pip install pyvortex
install the latest version using
pip install git+https://github.com/pankajkarman/pyvortex.git
Documentation
Latest documentation is available here.
Usage
pyvortex is easy to use. Just import:
import pyvortex as vr
Northern Hemisphere
Instantiate the PolarVortex class using:
pol = PolarVortex(pv, uwind)
Get equivalent lqtitude for the provided vorticity data as:
eql = pol.get_eql()
If you want to get both equivalent latitude and Vortex edge, just use:
eql = pol.get_edge(min_eql=30)
Example:
Southern Hemisphere
Flip pv and uwind along latitude dimension and multiply pv by -1. All other things will be the same.
Example:
