https://github.com/TEOS-10/GSW-Python

Python implementation of TEOS-10 GSW based on ufunc wrappers of GSW-C
https://github.com/TEOS-10/GSW-Python

Last synced: about 2 months ago
JSON representation

Python implementation of TEOS-10 GSW based on ufunc wrappers of GSW-C

• Host: GitHub
• URL: https://github.com/TEOS-10/GSW-Python
• Owner: TEOS-10
• License: other
• Created: 2017-03-28T20:14:20.000Z (over 7 years ago)
• Default Branch: main
• Last Pushed: 2024-04-30T19:31:25.000Z (2 months ago)
• Last Synced: 2024-05-02T06:10:54.371Z (2 months ago)
• Language: C
• Homepage: https://teos-10.github.io/GSW-Python
• Size: 12.8 MB
• Stars: 137
• Watchers: 20
• Forks: 30
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Lists

• open-sustainable-technology - GSW-Python - This Python implementation of the Thermodynamic Equation of Seawater 2010. (Hydrosphere / Ocean Carbon and Temperature)
• awesome-open-climate-science - GSW-Python -  Thermodynamic equation of state for seawater (Software / Oceanography)

README

        
# GSW-Python

[![Tests](https://github.com/TEOS-10/GSW-Python/actions/workflows/tests.yml/badge.svg)](https://github.com/TEOS-10/GSW-Python/actions/workflows/tests.yml)

[![Wheels](https://github.com/TEOS-10/GSW-Python/actions/workflows/cibuildwheel.yml/badge.svg)](https://github.com/TEOS-10/GSW-Python/actions/workflows/cibuildwheel.yml)

[![DOI](https://zenodo.org/badge/86503067.svg)](https://zenodo.org/badge/latestdoi/86503067)

This Python implementation of the Thermodynamic Equation of Seawater 2010 (TEOS-10) is based primarily on numpy ufunc wrappers of the GSW-C implementation.

This library replaces the original [python-gsw](https://github.com/TEOS-10/python-gsw) pure-python implementation..

The primary reasons for this change are that by building on the C implementation we reduce code duplication and we gain an immediate update to the 75-term equation.  

Additional benefits include a major increase in speed,

a reduction in memory usage,

and the inclusion of more functions.

The penalty is that a C (or MSVC C++ for Windows) compiler is required to build the package from source.

**Warning: this is for Python >=3.8 only.**

Documentation is provided at https://teos-10.github.io/GSW-Python/.

For the core functionality, we use an auto-generated C extension

module to wrap the C functions as numpy [ufuncs](https://docs.scipy.org/doc/numpy/reference/ufuncs.html),

and then use an autogenerated Python module to add docstrings and handle masked arrays.

165 scalar C functions with only double-precision arguments and return values are wrapped as ufuncs,

and 158 of these are exposed in the ``gsw`` namespace with an additional wrapper in Python.

A hand-written wrapper is used for one C function, and others are re-implemented directly in Python instead of being wrapped.

Additional functions present in GSW-Matlab but not in GSW-C may be re-implemented in Python,

but there is no expectation that all such functions will be provided.

## Installation

Pip users can install the pre-built wheels with:

```shell

pip install gsw

```

conda users will find binaries on conda-forge,

```shell

conda install gsw --channel conda-forge

```

The development version of the package can be installed from a clone of the repo using

```shell

pip install .

```

It is neither necessary nor recommended to run the code generators,

and no instructions are provided for them;

their output is included in the repo.

You will need a suitable compiler:

gcc or clang for unix-like systems,

or the MSVC compiler set used for Python itself on Windows.

For Windows, some of the source code has been modified to C++ because the MSVC C compiler does not support the

C99 complex data type used in original GSW-C.

To test, after installation, run "pytest" from the source directory.

## Citation

If you use GSW-Python, please cite: McDougall, T.J. and P.M. Barker, 2011: Getting started with TEOS-10 and the Gibbs Seawater (GSW) Oceanographic Toolbox, 28pp., SCOR/IAPSO WG127, ISBN 978-0-646-55621-5

```bibtex

@book{mcdougall2011getting,

  author = {McDougall, T. J. and Barker, P. M.},

  title = {Getting started with TEOS-10 and the Gibbs Seawater (GSW) Oceanographic Toolbox},

  year = {2011},

  pages = {28},

  publisher = {SCOR/IAPSO WG127},

  isbn = {978-0-646-55621-5}

}

```

## Note for xarray users

A wrapper around gsw called [gsw-xarray](https://github.com/DocOtak/gsw-xarray) exists for xarray.

It adds CF compliant attributes when possible, units, and name.

## Note on generating the docstrings

The autogenerated docstrings are checked with codespell in the CIs.

when autogenerating them we need to run ``pre-commit run --all-files`` and fix the documentation issues found.