Skip to content

Commit 143b03f

Browse files
committed
Merge contributing to MITgcm and getting started chapter from jrscott
2 parents 2d1257b + a0b2c13 commit 143b03f

File tree

16 files changed

+15680
-92
lines changed

16 files changed

+15680
-92
lines changed

doc/contributing.rst

Lines changed: 90 additions & 44 deletions
Large diffs are not rendered by default.

doc/examples/examples.rst

Lines changed: 0 additions & 27 deletions
This file was deleted.

doc/figs/git_setup.ai

Lines changed: 12622 additions & 0 deletions
Large diffs are not rendered by default.

doc/figs/git_setup.pdf

1.19 MB
Binary file not shown.

doc/figs/git_setup.svg

Lines changed: 1 addition & 1 deletion
Loading

doc/examples/barotropic_gyre/barotropic_gyre.rst renamed to doc/getting_started/barotropic_gyre/barotropic_gyre.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ where :math:`L_{y}` is the lateral domain extent (1200~km) and
3434
:numref:`fig_eg_baro_simulation_config` summarizes the configuration simulated.
3535

3636

37-
.. figure:: barotropic_gyre/figs/simulation_config.*
37+
.. figure:: figs/simulation_config.*
3838
:width: 70%
3939
:align: center
4040
:alt: barotropic gyre configuration
@@ -221,7 +221,7 @@ are
221221

222222
other lines in the file `input/data` are standard values that are described in the MITgcm Getting Started and MITgcm Parameters notes.
223223

224-
.. literalinclude:: ../../verification/tutorial_barotropic_gyre/input/data
224+
.. literalinclude:: ../../../verification/tutorial_barotropic_gyre/input/data
225225
:linenos:
226226
:caption: verification/tutorial_barotropic_gyre/input/data
227227

@@ -270,7 +270,7 @@ Two lines are customized in this file for the current experiment
270270
- `sNy=60,`
271271
- this line sets the lateral domain extent in grid points for the axis aligned with the y-coordinate.
272272

273-
.. literalinclude:: ../../verification/tutorial_barotropic_gyre/code/SIZE.h
273+
.. literalinclude:: ../../../verification/tutorial_barotropic_gyre/code/SIZE.h
274274
:linenos:
275275
:caption: verification/tutorial_barotropic_gyre/code/SIZE.h
276276

0 commit comments

Comments
 (0)