Skip to main content

Differential calibrator of the vertical ocean turbulence closures.

Project description

Python Documentation Status Tests License: CC-BY-NC

Description

This package provides a framework for calibrating the parameters of vertical physics schemes of ocean circulation models using variational optimization. The parameters are calibrated through the minimization of an 'objective function' which compares model predictions with 'Large Eddy Simulations' (LES). Tunax is written in JAX in order to use automatic differentiation for computing the gradient of the objective function with respect to model parameters.

Package organisation

The closures are implemented in the folder tunax/closures/ and they are wrapped by a 'single column model' (SCM) implemented in tunax/model.py. The calibration part is in tunax/fitter.py. The folder notebooks/ contains example of usage of this framework. The folder docs/ is for the documentation configuration which is available [here] (https://tunax.readthedocs.io/en/latest/).

Installation

Stable version

Tunax is pip installable

pip install tunax

Tunax is installed by default with JAX on CPU.

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

tunax-0.1.0.tar.gz (34.7 kB view details)

Uploaded Source

Built Distribution

tunax-0.1.0-py3-none-any.whl (38.7 kB view details)

Uploaded Python 3

File details

Details for the file tunax-0.1.0.tar.gz.

File metadata

  • Download URL: tunax-0.1.0.tar.gz
  • Upload date:
  • Size: 34.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.12.6 Darwin/23.4.0

File hashes

Hashes for tunax-0.1.0.tar.gz
Algorithm Hash digest
SHA256 7b821b084b4451facdbaa4755845176cbb301418c0693a83953d624291aa5f51
MD5 8e617d9ebe2bb8f1db0f6b9f66373a07
BLAKE2b-256 3938eee5ab7465b204afc00d0207cf851c0f3c5f6e0fae711abc977418e05f66

See more details on using hashes here.

File details

Details for the file tunax-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: tunax-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 38.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.12.6 Darwin/23.4.0

File hashes

Hashes for tunax-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0ae60678618fa7ce5f161bfa6cf4f51c2d6a312312e27d88a432afb590a325a3
MD5 d2ea9088fb6e993a91f0ded3f4b997e4
BLAKE2b-256 2b586876e9ce1b6eef52df9a82e89c846b5abdd126c05fb10df11ec810809b28

See more details on using hashes here.

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