New URL for NEMO forge!   http://forge.nemo-ocean.eu

Since March 2022 along with NEMO 4.2 release, the code development moved to a self-hosted GitLab.
This present forge is now archived and remained online for history.
NEMO_guide.rst in NEMO/trunk/doc/rst/source – NEMO

source: NEMO/trunk/doc/rst/source/NEMO_guide.rst @ 10598

Last change on this file since 10598 was 10598, checked in by nicolasmartin, 4 years ago

Standardisation of title markup and convert few to lowercase

File size: 1.5 KB
Line 
1#################
2Quick Start Guide
3#################
4
5..
6   For headings markup, this convention is recommended from Python’s Style Guide
7   # with overline, for parts
8   * with overline, for chapters
9   =, for sections
10   -, for subsections
11   ^, for subsubsections
12   ", for paragraphs
13
14   'global.rst' contains a list of common directives (roles, substitutions and URL links)
15   It is loaded for each file thanks to 'rst_epilog' setting in 'conf.py'
16
17.. toctree::
18   :hidden:
19   :caption: What's new in NEMO 4.0
20
21   release_notes
22
23.. toctree::
24   :hidden:
25   :caption: Getting started
26
27   install
28   configurations
29   test_cases
30
31.. toctree::
32   :hidden:
33   :caption: Setup your configuration
34
35   setup
36   diagnostics
37   tools
38
39.. toctree::
40   :hidden:
41   :caption: Advanced use
42
43   zooms
44   coupling
45   data_assimilation
46   tracers
47
48.. toctree::
49        :hidden:
50        :caption: Contributions are welcome!
51
52        contributing
53
54.. toctree::
55   :hidden:
56   :caption: Glossary
57
58   definitions
59
60.. include:: readme.rst
61
62.. Next headings markup acording to readme.rst
63
64Reference publications
65======================
66
67.. bibliography:: references.bib
68   :all:
69   :style: unsrt
70   :labelprefix: R
71
72Disclaimer
73==========
74
75The NEMO source code is freely available and distributed under CeCILL license
76(GNU GPL compatible - see ``./LICENSE``).
77
78You can use, modify and/or redistribute the software under its terms,
79but users are provided only with a limited warranty and the software's authors and
80the successive licensor's have only limited liability.
Note: See TracBrowser for help on using the repository browser.