Skip to main content

Neutral Surfaces in the Ocean

Project description

neutralocean

latest docs pypi package conda-forge package tests

Calculate neutral surfaces in the ocean, using Python.

The major task of this software is to calculate omega-surfaces, following the algorithm of Stanley et al. (2021). Omega surfaces are highly accurate approximately neutral surfaces that work by iteratively reducing the neutrality error.

There are also routines to calculate potential density surfaces, specific volume anomaly surfaces, neutral trajectories, the Veronis density label, and measures of neutrality error.

Topobaric surfaces (Stanley, 2019a) in their modified form (Stanley 2019b) are the most accurate approximately neutral surfaces that posses an exact geostrophic streamfunction (furnishing an Ertel potential vorticity with no baroclinic production term). Software to compute topobaric surfaces is significantly more complicated and is currently only available in the original MATLAB neutral-surfaces toolbox.

How to cite? If you use this software, the most appropriate paper to cite is Stanley et al. (2021).

Installation

Simply execute either

$ pip install neutralocean

if you use pip, or

$ conda install -c conda-forge neutralocean

if you use conda.

Documentation

See https://neutralocean.readthedocs.org

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

neutralocean-2.1.3.tar.gz (84.4 kB view hashes)

Uploaded Source

Built Distribution

neutralocean-2.1.3-py3-none-any.whl (110.2 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