Skip to content

Commit

Permalink
Update ReadMe
Browse files Browse the repository at this point in the history
  • Loading branch information
briochemc committed Sep 30, 2024
1 parent a68a9e4 commit f258ec5
Showing 1 changed file with 16 additions and 3 deletions.
19 changes: 16 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@

[![Build Status](https://github.com/TMIP-code/OceanTransportMatrixBuilder.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/TMIP-code/OceanTransportMatrixBuilder.jl/actions/workflows/CI.yml?query=branch%3Amain)

> [!WARNING]
> This is work in progress. Breaking changes expected.
The purpose of this package is to build transport matrices from standard CMIP model output as part of the Transport Matrix Intercomparison Project (TMIP).

By rearranging the 3D grid of the ocean into a vector, the divergence of the flow of any tracer can be conveniently expressed in matrix form.
Expand All @@ -14,9 +17,6 @@ The main application driving this project is for the validation of marine Carbon
However, these matrices are useful in a number of contexts, e.g., for avoiding spin ups, optimization, or novel diagnostics[^John_et_al_2020].
The motivation for sharing this package is thus to facilitate the use of novel diagnostics across CMIP models.

> [!WARNING]
> This is work in progress. Breaking changes expected.
## Example use

The intended use would be simply to feed the ocean transport output from a given CMIP model to the functions in this package to build the desired transport matrix.
Expand Down Expand Up @@ -59,6 +59,19 @@ indices = makeindices(modelgrid.v3D)

That's it! You've got yourself the transport matrix of your dreams!

> [!WARNING]
> This does not work for all CMIP models! See below for a list that passed the rudimentary tests.


## List of models tested

```
ACCESS1-3
ACCESS-ESM1-5
ACCESS-CM2
```

> [!TIP]
> The `test/` directory contains up-to-date examples for building the transport matrix and doing some simple calculations.
Expand Down

0 comments on commit f258ec5

Please sign in to comment.