Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/gaelforget/MITgcm.jl

Julia interface to MITgcm
https://github.com/gaelforget/MITgcm.jl

adjoint adjoint-sensitivities biogeochemistry climate climate-model climate-science ecology model ocean ocean-modelling ocean-sciences particles seaice tracers transport

Last synced: about 1 month ago
JSON representation

Julia interface to MITgcm

Awesome Lists containing this project

README

        

# MITgcm.jl

[![Documentation](https://img.shields.io/badge/docs-dev-blue.svg)](https://gaelforget.github.io/MITgcm.jl/dev)
[![codecov](https://codecov.io/gh/gaelforget/MITgcm.jl/branch/master/graph/badge.svg?token=zUK0vO5K3J)](https://codecov.io/gh/gaelforget/MITgcm.jl)
[![CI](https://github.com/gaelforget/MITgcm.jl/actions/workflows/ci.yml/badge.svg)](https://github.com/gaelforget/MITgcm.jl/actions/workflows/ci.yml)

[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/gaelforget/MITgcm.jl/master)
[![DOI](https://zenodo.org/badge/236192181.svg)](https://zenodo.org/badge/latestdoi/236192181)

Julia interface to [MITgcm](https://mitgcm.readthedocs.io/en/latest/?badge=latest) that allows user not only to analyze model output, but also to download the source code, build the model executable, modify run-time parameters, run model simulations, or verify model results against a benchmark.

Notebooks and tutorials are found in [the docs](https://gaelforget.github.io/MITgcm.jl/dev/examples/).

Examples / How-To

To open a notebook using [Pluto.jl](https://featured.plutojl.org):

1. open `julia` in terminal window
2. type command below at the `Julia` prompt
3. _new web browser tab should show `Pluto` prompt_
4. copy/paste a notebook URL from [the docs](https://gaelforget.github.io/MITgcm.jl/dev/examples/)

```
cd("examples/"); using Pluto; Pluto.run()
```

Examples / Running Models

- [MITgcm_configurations.jl](https://gaelforget.github.io/MITgcm.jl/dev/examples/MITgcm_configurations.html) : explore MITgcm configurations and their parameters.
- [MITgcm_worklow.jl](https://gaelforget.github.io/MITgcm.jl/dev/examples/MITgcm_worklow.html) : build, setup, run, and plot for any standard configuration.
- [MITgcm_run.jl](https://gaelforget.github.io/MITgcm.jl/dev/examples/MITgcm_run.html) : a more detailed look into compiling and running the model.
- [MITgcm\_scan\_output.jl](https://gaelforget.github.io/MITgcm.jl/dev/examples/MITgcm_scan_output.html) : scan `output.txt`, read grid, viz with `Makie.jl`

Examples / Analyzing Results

- [HS94_animation.jl](https://gaelforget.github.io/MITgcm.jl/dev/examples/HS94_animation.html) : run `hs94.cs-32x32x5`, read output, interpolate, and animate map
- [HS94_particles.jl](https://gaelforget.github.io/MITgcm.jl/dev/examples/HS94_particles.html) : compute particle trajectories from `hs94.cs-32x32x5` output
- [HS94_Makie.jl](https://gaelforget.github.io/MITgcm.jl/dev/examples/HS94_Makie.html) : example using `Makie.jl` instead of `Plots.jl`