Newer
Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
#################
NEMO User Guide
#################
.. For headings markup, this convention is recommended from Python’s Style Guide
# with overline, for parts
* with overline, for chapters
=, for sections
-, for subsections
^, for subsubsections
", for paragraphs
'global.rst' contains a list of roles, substitutions and URL links for the guide.
It is loaded for each file with the 'rst_epilog' setting in 'conf.py'
.. toctree::
:hidden:
.. todos
.. Only displayed with 'make drafthtml'
.. toctree::
:hidden:
:caption: Unpublished READMEs
:glob:
:titlesonly:
unpub/*
.. Only displayed with 'make drafthtml'
.. toctree::
:hidden:
:caption: Getting started
install
changes
migration
cfgs
tests
.. toctree::
:hidden:
:caption: Setup a testing framework
sette
.. toctree::
:hidden:
:caption: Setup your configuration
setup
diags
tools
.. toctree::
:hidden:
:caption: Advanced use
zooms
cplg
da
tracers
.. toctree::
:hidden:
:caption: Miscellaneous
cite
contrib
changes
acro
.. :Release: |release|
.. note::
Important foreword: this document is a "How to" explaining how to get started with NEMO. For detailed description of NEMO functionalities and how these are build in the code, please refer to the Reference manuals :doc:`here <cite>`
This User's guide for NEMO version: |release|. Use the sidebar links for navigation or start :doc:`here <install>`