|
|
In the following article, we summarize the configurations of all examples provided by the official [documentation of the MITgcm](https://mitgcm.readthedocs.io/en/latest/overview/overview.html).
|
|
|
# Conventions
|
|
|
For a better overview, we do not list all distinct configuration files used in each example.
|
|
|
Instead, we use the following conventions:
|
|
|
1. All examples contain basic configuration files: `input/data`, `input/eedata`, `code/SIZE.h`. Therefore, we do not mention them explicitly.
|
|
|
2. Some example experiments use packages, that provide some additional functionality. These packages are used by providing corresponding configuration files. These configuration files are `input/data.{packagename}` `input/{packagename}_SIZE.h`. However, not always all of these files are used together. Therefore, for each example, we mention only which package is used. If no further notes are made, all configuration files associated with the package are used.
|
|
|
3. If a package is used in an experiment, these are declared in `code/package.conf` and activated
|
|
|
in `input/data.package`
|
|
|
#Examples
|
|
|
## [Barotropic Ocean Gyre](https://mitgcm.readthedocs.io/en/latest/examples/barotropic_gyre/barotropic_gyre.html)
|
|
|
## [Baroclinic Ocean Gyre](https://mitgcm.readthedocs.io/en/latest/examples/baroclinic_gyre/baroclinic_gyre.html)
|
|
|
## [Southern Ocean Reentrant Channel Example](https://mitgcm.readthedocs.io/en/latest/examples/reentrant_channel/reentrant_channel.html)
|
|
|
TODO |
|
|
\ No newline at end of file |