source:
NEMO/trunk/doc/rst/source/NEMO_guide.rst
@
10460
| Last change on this file since 10460 was 10460, checked in by nicolasmartin, 5 years ago | |
|---|---|
| File size: 1.3 KB | |
| Rev | Line | |
|---|---|---|
| [10201] | 1 | ################# |
| [10186] | 2 | Quick Start Guide |
| [10201] | 3 | ################# |
| [10186] | 4 | |
| [10201] | 5 | .. |
| [10279] | 6 | For headings markup, this convention is recommended from Python’s Style Guide |
| [10201] | 7 | # with overline, for parts |
| 8 | * with overline, for chapters | |
| 9 | =, for sections | |
| 10 | -, for subsections | |
| 11 | ^, for subsubsections | |
| 12 | ", for paragraphs | |
| [10186] | 13 | |
| [10279] | 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 | ||
| 20 | release_notes.rst | |
| 21 | ||
| 22 | .. toctree:: | |
| 23 | :hidden: | |
| 24 | :caption: Getting started | |
| 25 | ||
| 26 | install | |
| 27 | configurations | |
| 28 | test_cases | |
| 29 | ||
| 30 | .. toctree:: | |
| 31 | :hidden: | |
| 32 | :caption: Setup your configuration | |
| 33 | ||
| 34 | setup | |
| 35 | diagnostics | |
| 36 | tools | |
| 37 | ||
| 38 | .. toctree:: | |
| 39 | :hidden: | |
| 40 | :caption: Advanced use | |
| 41 | ||
| 42 | zooms | |
| 43 | coupling | |
| 44 | assimilation | |
| 45 | tracers | |
| 46 | ||
| 47 | .. toctree:: | |
| 48 | :hidden: | |
| 49 | :caption: Glossary | |
| 50 | ||
| 51 | definitions | |
| 52 | ||
| 53 | .. include:: readme.rst | |
| 54 | ||
| 55 | .. Next headings markup acording to readme.rst | |
| 56 | ||
| [10460] | 57 | Reference publications |
| 58 | ====================== | |
| [10279] | 59 | |
| 60 | .. bibliography:: references.bib | |
| 61 | :all: | |
| 62 | :style: unsrt | |
| 63 | :labelprefix: R | |
| 64 | ||
| 65 | Disclaimer | |
| 66 | ========== | |
| 67 | ||
| 68 | The NEMO source code is freely available and distributed under CeCILL license | |
| 69 | (GNU GPL compatible - see ``./LICENSE``). | |
| 70 | ||
| 71 | You can use, modify and/or redistribute the software under its terms, | |
| 72 | but users are provided only with a limited warranty and the software's authors and | |
| 73 | the successive licensor's have only limited liability. |
Note: See TracBrowser
for help on using the repository browser.
