Skip to main content

Polar vortex edge detection using Nash criteria

Project description

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: Arctic Vortex

Southern Hemisphere

Flip pv and uwind along latitude dimension and multiply pv by -1. All other things will be the same.

Example:

Polar Vortex

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyvortex-0.2.3.tar.gz (3.5 kB view hashes)

Uploaded Source

Built Distribution

pyvortex-0.2.3-py3-none-any.whl (5.0 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page