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.
README.rst in NEMO/trunk – NEMO

source: NEMO/trunk/README.rst @ 9709

Last change on this file since 9709 was 9650, checked in by nicolasmartin, 7 years ago

Reorganisation plan for NEMO repository: upgrade of makenemo and compilation scripts to handle both ./cfgs & ./tests
Demonstration cases (-a) and remote configurations (-u) will be build in ./tests in contrast to
reference configurations (-r) in ./cfgs.
Now compile a test cases has the same way of syntax as the others: ./makenemo -n WAD_ST -a WAD [...]
Still have to run sette tests and block SVN external revisions.

File size: 3.1 KB
Line 
1.. role:: rstblue
2.. role:: rstgrey
3.. role:: rstgreen
4
5================
6NEMO Ocean Model
7================
8
9NEMO_ (Nucleus for European Modelling of the Ocean) is a state-of-the-art modelling framework of
10ocean related engines for oceanographic research, operational oceanography, seasonal forecast and
11[paleo]climate studies.
12
13The NEMO ocean model has 3 major components:
14
15- :rstblue:`OPA` is fundamental to all users by modelling the ocean [thermo]dynamics and
16  solving the primitive equations;
17- :rstgrey:`LIM` for sea-ice simulates ice [thermo]dynamics, brine inclusions and
18  subgrid-scale thickness variations;
19- :rstgreen:`TOP-PISCES` models biogeochemistry with TOP for
20  the on/offline oceanic tracers transport and PISCES for the biogeochemical processes.
21
22These physical engines are described in their respective `reference publications`_.
23
24They are complemented by a 2-way nesting software (AGRIF_) and
25a versatile data assimilation interface with 3 different modules
26(linear-tangent TAM, observational operators OBS, and increment ASM).
27
28------------
29Applications
30------------
31
32| Distributed under CeCILL license (GNU GPL compatible - see ``LICENSE``),
33  the framework offers several builtins reference configurations to
34  check your computing architecture and evaluate the model skills and performances (``./cfgs``).
35| The end user could also find some idealized test cases on the web to serve as examples and
36  to study particular processes.
37
38A set of tools is also provided to setup your own configuration and
39[pre|post]process your data (``./tools``).
40
41-------
42Options
43-------
44
45For writing diagnostics in a efficient way, NEMO make use of XIOS_ server which
46controlled the outputs using XML input file.
47
48To enable Earth system modelling, NEMO can be interfaced via
49OASIS_ coupleur to external components such as atmospheric models or
50alternative models of sea-ice or biogeochemistry.
51
52-------------
53Documentation
54-------------
55
56The NEMO reference manual can be generated from the LaTeX source code (``./doc``),
57either in PDF or in HTML format, but it mights require some additionnal installations.
58
59In any case, both formats are available online on the `NEMO website`__.
60
61---------------------
62Community development
63---------------------
64
65| The NEMO Consortium gathering 6 European institutes organises the sustainable development in order to
66  keep a reliable evolving system since 2008.
67| It defined the multiyear development strategy which is implemented by the NEMO System Team.
68
69--------
70Acronyms
71--------
72
73AGRIF
74 Adaptive Grid Refinement In Fortran
75
76LIM
77 Louvain-la-Neuve Ice Model
78
79OPA
80 "Océan PArallélisé" (french)
81
82PISCES
83 Pelagic Interactions Scheme for Carbon and Ecosystem Studies
84
85TAM
86 Tangent Adjoint Model
87
88TOP
89 Tracers in Ocean Paradigm
90
91XIOS
92 XML Input Output Server
93
94----
95
96.. _AGRIF:                  http://agrif.imag.fr
97.. _Forge:                  http://forge.ipsl.jussieu.fr/nemo
98.. _NEMO:                   http://www.nemo-ocean.eu
99.. _OASIS:                  http://verc.enes.org/oasis
100.. _reference publications: http://www.nemo-ocean.eu/bibliography/documentation
101.. _XIOS:                   http://forge.ipsl.jussieu.fr/ioserver
102
103.. __:  NEMO_
Note: See TracBrowser for help on using the repository browser.