source: trunk/README.rst @ 9476

Last change on this file since 9476 was 9476, checked in by nicolasmartin, 3 years ago

Integrate ASCII image as literal block for rendering

  • Property svn:mime-type set to text/x-rst
File size: 5.7 KB
Line 
1.. role:: rstblue
2.. role:: rstgrey
3.. role:: rstgreen
4
5=============
6NEMO in brief
7=============
8
9::
10  @@@@@@O$$$$$$@@@@@@#$$$$$$&@#$$$$$$$$$$$$$$$&@O$$$$$$&@@@@@@@@@$$$$$$O@@@@@@@@@@@O$$%$O@@@@@@@@@@@@@
11  @@@@@@?!!!!!!#@@@@@O!!!!!!#@$!!!!!!!!!!!!!!!#@%!!!!!!?&@@@@@@@$!!!!!!?@@@@@@@@&O#&&&&%??$#@@@@@@@@@@
12  @@@@@@?!!!!!!?@@@@@O!!!!!!#@$!!!!!!!!!!!!!!!#@%!!!!!!!%@@@@@@O!!!!!!!?@@@@@@@O#@@&%??!!!!!$@@@@@@@@@
13  @@@@@@?!!!!!!!O@@@@O!!!!!!#@$!!!!!!?????????&@%!!!!!!!!$@@@@#!!!!!!!!?@@@@@&O&@&&O$$?!!!!!!%&@@@@@@@
14  @@@@@@?!!!!!!!!#@@@O!!!!!!#@$!!!!!!#&&&&&&&&@@%!!!!!!!!!$@@&?!!!!!!!!?@@@@@O&@&??&@@&O!!!!!!%@@@@@@@
15  @@@@@@?!!!!!!!!?&@@O!!!!!!#@$!!!!!!#@@@@@@@@@@%!!!!!!!!!!O@%!!!!!!!!!?@@@@O&@@O!O@@@@&O!!!!!!$@@@@@@
16  @@@@@@?!!!!!!!!!?#@O!!!!!!#@$!!!!!!#@@@@@@@@@@%!!!!!!!!!!!%!!!!!!!!!!?@@@&O@@$!!O&@@@@&O!!!!!!#@@@@@
17  @@@@@@?!!!!!!!!!!!OO!!!!!!#@$!!!!!!$OOOOO@@@@@%!!!!!!!!!!!!!!!!!!!!!!?@@@O@&%!!!!!%#&&@&?!!!!!%@@@@@
18  @@@@@@?!!!!!!!!!!!!!!!!!!!#@$!!!!!!!!!!!?@@@@@%!!!!!!!!!!!!!!!!!!!!!!?@@@O&!!!!!!%%eO&@$!!!!!!%&@@@@
19  @@@@@@?!!!!!!!!!!!!!!!!!!!#@$!!!!!!!!!!!?@@@@@%!!!!!!!!!!!!!!!!!!!!!!?@@&&$!!!?$O$Oe$@@!!!!!!eO#@@@@
20  @@@@@@?!!!!!!!!!!!!!!!!!!!#@$!!!!!!?%%%%$@@@@@%!!!!!!!!!!!!!!!!!!!!!!?@@O&!!!!$&$#%!#@@?!!!!!!$O@@@@
21  @@@@@@?!!!!!!!!!!!!!!!!!!!#@$!!!!!!#@@@@@@@@@@%!!!!!!!!!!!!!!!!!!!!!!?@@O&!!!!%?O@%&&&@$!!!!!!?O@@@@
22  @@@@@@?!!!!!?#!!!!!!!!!!!!#@$!!!!!!#@@@@@@@@@@%!!!!!!#!!!!!!!!O?!!!!!?@@O#!!!!!!?@@@@@OO!!!!$e?O@@@@
23  @@@@@@?!!!!!?@#?!!!!!!!!!!#@$!!!!!!#@@@@@@@@@@%!!!!!!&#!!!!!!%&?!!!!!?@@OOO?!!!%%@@@@@#?!%$#O%%$@@@@
24  @@@@@@?!!!!!?@@&%!!!!!!!!!#@$!!!!!!?????????&@%!!!!!!&@O!!!!?&@?!!!!!?@@#&##%$&&&@@@@@@$%#&O!??O@@@@
25  @@@@@@?!!!!!?@@@@#?!!!!!!!#@$!!!!!!!!!!!!!!!#@%!!!!!!&@@$!!!&@@?!!!!!?@@&#$&@@@@@@@@@@@?O%%?!!!#@@@@
26  @@@@@@?!!!!!?@@@@@@#%!!!!!#@$!!!!!!!!!!!!!!!#@%!!!!!!&@@@$!O@@@?!!!!!?@@@O#&&@@@@@@@@@@O?!!!!!?&@@@@
27  @@@@@@?!!!!!?@@@@@@@@&O$%%#@#O##&&&&&&&&##OO&@$!!!!!!&@@@@O@@@@?!!!!!?@@@O&&#&@@@@@@@@@$!!!!!!$@@@@@
28  @@@@@@?!!!!!?@@@@@@@@@@@@@@&&#O$$$%%%%$$$OO#&@@&#O%?!&@@@@@@@@@?!!!!!?@@@@OOO@@@@@@@@@&!!!!!!!&@@@@@
29  @@@@@@?!!!!!?@@@@@@@@@&#$%?!!!!!!!!!!!!!!!!!!!?%O#@@#@@@@@@@@@@?!!!!!?@@@@#!!%&@@@@@@@%!!!!!!O@@@@@@
30  @@@@@@?!!!!!?@@@@@@#$?!!!!!!!!!!!!!!!!!!!!!!!!!!!!!%$&@@@@@@@@@?!!!!!?@@@@@#!!%@@@@@@@O!!$&$$@@@@@@@
31  @@@@@@?!!!!!?@@@O%!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!?$#@@@@@@?!!!!!?@@@@@@O!!?@@@@@@@&&@#O@@@@@@&&
32  @@@@@@?!!!?O&#$?!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!?$#@@@$?!!!!?@@@@@@@&%!?$#@@@@@&O#@@@@@#O&@
33  @@@@@@?!?O&#%!!!!!!!!!??%%$$$OOOOOOOOOO$$%%??!!!!!!!!!!!!!!!?%O&&&O$%%@@@@@@@@@#%?%####O#@@@&#$$#@@@
34  @@@@@@%O&#%!!!!!?%$O#&&@@@@@@@@@@@@@@@@@@@@@&&#O$%?!!!!!!!!!!!!!?$O&&&@@@@@@@@@@@&&&&&&&&#$%?%#@@@@@
35  @@@@@@&#%!!!?$#&&@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@&&#O%?!!!!!!!!!!!!??%$OOO#######OO$%??!!?%#@@@@@@@
36  @@@@@&$!?%O&@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@&#O$%?!!!!!!!!!!!!!!!!!!!!!!!!!?$#&@@@@@@@@@
37  @@@@O?%O&@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@&#OO$%????!!!!!!!!??%%O#&@@@@@@@@@@@@@
38  @@&$$&@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@&&&&&&&&&@@@@@@@@@@@@@@@@@@@@
39  @#O&@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
40  &&@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
41
42-----
43About
44-----
45
46`NEMO <www.nemo-ocean.eu>`_ (Nucleus for European Modelling of the Ocean) is
47a state-of-the-art modelling framework of ocean related engines for oceanographic research,
48operational oceanography, seasonal forecast and [paleo]climate studies.
49
50The NEMO ocean model has 3 major components:
51
52- :rstblue:`OPA` is fundamental to all users by modelling the ocean [thermo]dynamics and
53  solving the primitive equations;
54- :rstgrey:`LIM` for sea-ice simulates ice [thermo]dynamics, brine inclusions and
55  subgrid-scale thickness variations;
56- :rstgreen:`TOP-PISCES` models biogeochemistry with TOP for the on/offline oceanic tracers transport and
57  PISCES for the biogeochemical processes.
58
59| These physical engines are described in their respective reference publications listed as BibTeX entries
60  in ``./REFERENCES.bib``.
61| They are complemented by a 2-way nesting software (`AGRIF <http://agrif.imag.fr>`_) and
62  a versatile data assimilation interface with 3 different modules
63  (linear-tangent TAM, observational operators OBS, and increment ASM).
64
65------------
66Applications
67------------
68
69| Shared under `CeCILL free software license <http://www.cecill.info>`_ (``./LICENSE.txt``),
70  the framework contains several builtins reference configurations and idealized test cases to serve as
71  examples and to study particular processes.
72| A set of tools is also provided to setup your own configuration and [pre|post]process your data.
73|
74| For writing diagnostics in a efficient way,
75  NEMO requires `XIOS <http://forge.ipsl.jussieu.fr/ioserver>`_ as dependency
76  which controlled the outputs using XML input file.
77| To enable Earth system modelling, NEMO can be interfaced via `OASIS <http://verc.enes.org/oasis>`_ to
78  interact with external components such as atmosphere models or
79  alternative models of sea-ice or biogeochemistry.
80
81---------------------
82Community development
83---------------------
84
85| The NEMO Consortium gathering 6 European institutes organises the sustainable development (
86  ``./GOVERNANCE.rst``) in order to keep a reliable evolving system since 2008 (``./RELEASES.rst``).
87| It defined the multiyear development strategy (``./ROADMAP.rst``) which is implemented by
88  the NEMO System Team (``./MAINTAINERS.rst``).
89
90--------
91Acronyms
92--------
93
94AGRIF
95 Adaptive Grid Refinement In Fortran
96
97LIM
98 Louvain-la-Neuve Ice Model
99
100OPA
101 "Océan PArallélisé" (french)
102
103PISCES
104 Pelagic Interactions Scheme for Carbon and Ecosystem Studies
105
106TAM
107 Tangent Adjoint Model
108
109TOP
110 Tracers in Ocean Paradigm
111
112XIOS
113 XML Input Output Server
Note: See TracBrowser for help on using the repository browser.