Skip to content

Commit 5aa9a1e

Browse files
committed
update ReadMe
1 parent ecafc78 commit 5aa9a1e

1 file changed

Lines changed: 11 additions & 6 deletions

File tree

README.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -17,13 +17,19 @@ The code of this package is an extension of the work of Matt Chamberlain, who bu
1717

1818
The original application driving this project was for estimating ocean sequestration times for Carbon Capture and Storage (CCS) and Carbon Dioxide Removal (CDR) by computing the timescales and pathways for water in the deep ocean to reemerge to the surface[^DeVries_etal_2012][^Siegel_etal_2021].
1919
A paper, titled "The sequestration efficiency of the deep ocean", has been published in GRL[^Pasquier_etal_2025].
20-
However, these matrices are useful in many different contexts, e.g., for avoiding spin ups, optimisation, or novel diagnostics[^John_et_al_2020].
21-
The motivation for sharing this package is thus to facilitate the use of novel diagnostics across CMIP models.
20+
21+
However, **these matrices are useful in many other contexts**, e.g., for avoiding spin ups, optimisation, or novel diagnostics[^John_et_al_2020].
22+
We are sharing this package to get people to use transport matrices and produce novel diagnostics of CMIP models.
2223

2324
## Example use
2425

25-
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.
26-
After the required NetCDF files have been created (see some preliminary but working Python code for creating such files in [TMIP-code/notebooks](https://github.com/TMIP-code/notebooks))
26+
To build a transport matrix, we simply need the transport output from a CMIP model archive.
27+
Below is an example of doing so.
28+
29+
> [!TIP]
30+
> The NetCDF files used below were created from CMIP archives (I averaged the mass transports over the 1990s; you can find the Python code for creating them in [TMIP-code/notebooks](https://github.com/TMIP-code/notebooks))
31+
> But the `test/` directory also contains other examples, including one downloading CMIP data for you!
32+
2733

2834
```julia
2935
using NetCDF
@@ -91,8 +97,7 @@ ACCESS-CM2
9197
ACCESS-OM2
9298
```
9399

94-
> [!TIP]
95-
> The `test/` directory contains up-to-date examples for building the transport matrix and doing some simple calculations.
100+
96101

97102
## Citation
98103

0 commit comments

Comments
 (0)