Skip to content

geoffstanley/neutralocean

Repository files navigation

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

This package is on PyPI and conda-forge. Simply execute one of the following commands:

  • pip install neutralocean
  • pixi add neutralocean
  • uv add neutralocean
  • conda install -c conda-forge neutralocean

Documentation

See https://neutralocean.readthedocs.org

About

Calculate neutral surfaces in the ocean, using Python

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages