Skip to content

Commit 911843e

Browse files
author
Hans Burchard
committed
fix conflict
2 parents f5f74c5 + ed13117 commit 911843e

3 files changed

Lines changed: 129 additions & 2 deletions

File tree

README.md

Lines changed: 69 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,73 @@
44

55
GOTM - the **G**eneral **O**cean **T**urbulence **M**odel is an ambitious name for a one-dimensional water column model for marine and limnological applications. It is coupled to a choice of traditional as well as state-of-the-art parameterisations for vertical turbulent mixing. The package consists of the FORTRAN source code, a number of idealised and realistic test cases, and a scientific documentation, all published under the GNU public license.
66

7-
A comprehensive description including compilation instructions are given at the official [GOTM homepage](http://www.gotm.net/portfolio/software).
7+
Further information about GOTM can be found [here](https://gotm.net).
88

9+
### Manual build and install
10+
11+
GOTM being written in Fortran requires compilation before it can be used.
12+
13+
Below is provided a short description on how to obtain the code, configure, compile and install GOTM.
14+
15+
#### Cloning the code
16+
17+
The [GOTM source code](https://github.com/gotm-model/code) is in a Git repository and as a first step this code most be cloned to the local computer(*). [Git](https://git-scm.com/) must be installed.
18+
19+
Not strictly necessary creating a new folder for GOTM is a good idea.
20+
```
21+
mkdir GOTM
22+
cd GOTM
23+
```
24+
Now clone the code to the local machine:
25+
```
26+
git clone --recurse-submodules https://github.com/gotm-model/code.git
27+
```
28+
#### Configuring the code for compilation
29+
30+
A few requisits must be fullfilled befor proceeding. Being general descriptions the following instructions should work both on Linux/Mac and Windows. The example commands are to be executed in a terminal window - alternatives using a GUI is possible but beyond the instructions given here.
31+
32+
As a common build system we use [CMake](https://cmake.org/) and [Ninja](https://ninja-build.org/). So please install these before proceeding.
33+
34+
Furthermore, a Fortran compiler must be installed and discoverable by CMake.
35+
36+
NetCDF has been - and maybe still will be a headache - but it is assumed that NetCDF is installed with Fortran support. For Windows we provide a prebuilt set of libraries.
37+
38+
Configuration is done with cmake - and example being:
39+
```
40+
cmake -G Ninja -B build -S code
41+
```
42+
This will create a new folder - build - with the necessary information for actual compiling the code.
43+
44+
The build system for GOTM provides support for options to pass to the actual compilation. These are provided as extra arguments to the above cmake execution. As and example to include support for ice - use the following:
45+
46+
```
47+
cmake -B build -S code -DGOTM_USE_STIM
48+
```
49+
It is always safe to completely remove the build folder and start all over
50+
51+
#### Compiling the code
52+
53+
If the cmake command did not result in any errors we are ready to actually compile the code into an executable:
54+
```
55+
cmake --build build
56+
```
57+
This will take a little while but should en up in a compiled GOTM executable in the build/folder.
58+
This executable is ready to run but for convinience you might install it in a folder in the PATH on your computer - in which case you can just type - gotm - in any folder.
59+
60+
#### Installing the GOTM executable
61+
The installation also is done by CMake:
62+
```
63+
cmake --install build --prefix <folder_in_your_path>
64+
```
65+
To test if it works open a new terminal window and execute - gotm.
66+
67+
#### GOTM test cases
68+
GOTM comes with a number of ready to run test cases. There are also in a Git repository and can be obtained like:
69+
```
70+
git clone --recurse-submodules https://github.com/gotm-model/cases.git
71+
```
72+
Entering any of the cases folders and just executing - gotm - should run the model for the specific configuration.
73+
74+
An older description is provided here [GOTM homepage](http://www.gotm.net/portfolio/software).
75+
76+
(*) For people who intend to contribute to the GOTM source code a 'fork' is a better solution.

doc/gotm_pub.bib

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,41 @@ @String{acc
3939
@String{sub = "Submitted"}
4040
@String{inp = "In Press"}
4141

42+
@article{miracca_etal_2025,
43+
title={Turbulence Observations and Energetics of Diurnal Warm Layers},
44+
author={Miracca-Lage, Mariana and M{\'e}nesguen, Claire and Schmitt, Mira and Umlauf, Lars and Merckelbach, Lucas and Carpenter, Jeffrey R},
45+
journal={J. Phys. Oceanogr.},
46+
volume={55},
47+
number={11},
48+
pages={2141--2158},
49+
year={2025},
50+
doi = {https://doi.org/10.1175/JPO-D-25-0026.1},
51+
publisher={American Meteorological Society}
52+
}
53+
54+
@article{peng_etal_2025,
55+
title={Interactions between diurnal warm layers and surface-layer fronts},
56+
author={Peng, Jen-Ping and Jones, Nicole L and Rayson, Matthew D and Schmitt, Mira and Umlauf, Lars and Whitwell, Christopher and Keating, Shane R and Shakespeare, Callum J and Ivey, Gregory N},
57+
journal={J. Geophys. Res. Oceans},
58+
volume={130},
59+
number={1},
60+
pages={e2024JC021380},
61+
year={2025},
62+
doi = {https://doi.org/10.1029/2024JC021380},
63+
publisher={Wiley Online Library}
64+
}
65+
66+
@article{reichl_etal_2024,
67+
author = {Reichl, Brandon G. and Wittenberg, Andrew T. and Griffies, Stephen M. and Adcroft, Alistair},
68+
title = {Improving Equatorial Upper Ocean Vertical Mixing in the NOAA/GFDL OM4 Model},
69+
journal = {Earth Space Sci.},
70+
volume = {11},
71+
number = {10},
72+
pages = {e2023EA003485},
73+
doi = {https://doi.org/10.1029/2023EA003485},
74+
year = {2024}
75+
}
76+
4277
@article{schmitt_etal_2024,
4378
title={Diurnal warm layers in the ocean: Energetics, nondimensional scaling, and parameterization},
4479
author={Schmitt, Mira and Pham, HT and Sarkar, Sutanu and Klingbeil, Knut and Umlauf, Lars},
@@ -73,6 +108,19 @@ @article{burchard_etal_2023
73108
year={2023}
74109
}
75110

111+
@article{regev_etal_2023,
112+
title = {Using high level validation to increase lake ecosystem model reliability},
113+
journal = {Environmental Modelling & Software},
114+
volume = {162},
115+
pages = {105637},
116+
year = {2023},
117+
issn = {1364-8152},
118+
doi = {https://doi.org/10.1016/j.envsoft.2023.105637},
119+
url = {https://www.sciencedirect.com/science/article/pii/S1364815223000233},
120+
author = {Shajar Regev and Yohay Carmel and Gideon Gal},
121+
keywords = {Lake ecosystem modeling, Model evaluation, CSPS, WET, Lake Kinneret}
122+
}
123+
76124
@article{sane_etal_2023,
77125
author = {Sane, Aakash and Reichl, Brandon G. and Adcroft, Alistair and Zanna, Laure},
78126
title = {Parameterizing Vertical Mixing Coefficients in the Ocean Surface Boundary Layer Using Neural Networks},
@@ -152,6 +200,16 @@ @article{li_etal_2019
152200
year = {2019}
153201
}
154202

203+
@article{reichl_etal_2018,
204+
title = {A simplified energetics based planetary boundary layer (ePBL) approach for ocean climate simulations.},
205+
journal = {Ocean Modell.},
206+
volume = {132},
207+
pages = {112-129},
208+
year = {2018},
209+
doi = {https://doi.org/10.1016/j.ocemod.2018.10.004},
210+
author = {Brandon G. Reichl and Robert Hallberg},
211+
}
212+
155213
@article{schulz_etal_2017,
156214
title={Slope-induced tidal straining: Analysis of rotational effects},
157215
author={Schulz, Kirstin and Endoh, Takahiro and Umlauf, Lars},
Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
#bibtex2html -s siam -r -d gotm_pub.bib
22
bibtex2html -nodoc -noheader -s ieeetr -r -d gotm_pub.bib
33
#bibtex2html -nodoc -noheader -s ieeetr -a gotm_pub.bib
4-
scp gotm_pub.html gotm_pub_bib.html gotm.net:/var/www/www.gotm.net/htdocs/pages/documentation/
4+
#scp gotm_pub.html gotm_pub_bib.html gotm.net:/var/www/www.gotm.net/htdocs/pages/documentation/
5+
cp gotm_pub.html gotm_pub_bib.html ../../hugo/static/html/
56
rm gotm_pub.html gotm_pub_bib.html
67

0 commit comments

Comments
 (0)