source: NEMO/trunk/README.rst @ 9596

Last change on this file since 9596 was 9596, checked in by nicolasmartin, 2 years ago

Reorganisation plan for NEMO repository: preliminary implementation of the new trunk structure (ref #2015)

  • Deletion of useless 1st level, add new explicit names for folders
  • Extract dev tools (SETTE and Trusting) to /utils/CI
  • Extract figures folder from documentation to /utils/figures
  • Extrac TEST_CASES to /utils/test_cases
  • Move ./TOOLS/COMPILE to ./mk
  • Add few wiki files at the root: README, INSTALL and LICENSE with full text of CeCILL v2.0
  • Style: uppercase for wiki files, lowercase for folder names

Additionally, inclusion of routines renaming in NST: agrif_si3 → agrif_ice

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