Skip to content

Latest commit

 

History

History
108 lines (77 loc) · 3.86 KB

README.md

File metadata and controls

108 lines (77 loc) · 3.86 KB
Raw

Simple Ocean Models JAX (In Progress)

CodeFactor codecov

This repo hosts some models which are useful for studying ocean dynamics via simple ODES/PDEs. This is also a demonstration for how one can use different pieces from other packages. This repo is more of a model zoo to showcase how we can stitch these different pieces together to build simple, robust PDEs for research.

Motivation

There exists many large-scale general circulation models within the oceanography community, e.g. MITGCM, NEMO, MOM6, etc. There are even some more smaller scale GCMs that are written in more modern languages, e.g. veros, Oceananigans, etc. However, there is a missing step for many researchers to experiment with different, simple ocean-like dynamical systems as a stepping-stone to get to the more complex system. There exists a wealth of literature available for the community regarding the Lorenz family so that users can experiment with chaotic systems. There is also a number of key packages to allow users to experiment with simple models like the Quasigeostrophic model. There are also tidbit packages for shallow water models that are scattered through-out GitHub. However, we're missing a simple package which tries to aggregate the latest research on models like the QG and SWM. This package attempts to bridge this gap.

Functional API*. We use the finitevolx package for implementing spatial operators with finite volume considerations. We also use the spectraldiffx package for implementing spatial operators with the pseudospectral considerations. For timesteppers, we use the diffrax package for implementing advanced time stepping schemes like N-order Runge-Kutta or Heun.

Field API. (TODO) We have an operator API which will allow easier use of defining PDEs. This makes use of the fieldx package which defines custom spatiotemporal containers for fields which mimic the xarray package.

Key Features

Models.

  • Linear Shallow Water Model
  • Quasi-Geostrophic Model
  • Shallow Water Model
  • Multi-Layer Quasi-Geostrophic Model
  • Multi-Layer Shallow Water Model

Elliptical Solvers. We have the Discrete Sine Transform for the fast Poisson solver. We also have other solvers available from the JAX community.

Dynamical Model API. We have nicely bundled PDEs for specific use cases, e.g. shallow water, (multilayer) quasi-geostrophic, etc.

Installation

Pip Installation

We can install it directly through pip. First we create a development environment (optional).

conda create -n somax python=3.11 poetry
conda activate somax

Then we can pip install the somax package.

pip install git+https://github.com/jejjohnson/somax.git

Development

We also use poetry for the development environment. First, we clone the repo

git clone https://github.com/jejjohnson/somax.git
cd somax

Then we create a conda environment (optional)

conda create -n somax python=3.11 poetry
conda activate somax

We install all of the requirements using poetry

poetry install

Using GPUs

JAX allows us to use GPUs with minimal changes to the code. We can use any steps above to install the package. However, after installation, it may be necessary to reinstall jax with the GPU requirements. This can be done through pip.

conda activate somax
pip install --upgrade "jax[cuda]" -f https://storage.googleapis.com/jax-releases/jax_cuda_releases.html

Please see the installation instructions on the jax documentation for further instructions.