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.
Changeset 10187 for NEMO/trunk/README.rst – NEMO

Ignore:
Timestamp:
2018-10-09T19:08:59+02:00 (6 years ago)
Author:
nicolasmartin
Message:

Push draft versions of RST root files

File:
1 edited

Legend:

Unmodified
Added
Removed

  • NEMO/trunk/README.rst

    r9650 r10187  
    11.. role:: rstblue 
     2.. role:: rstgreen 
    23.. role:: rstgrey 
    3 .. role:: rstgreen 
     4.. role:: rstgreysup(sup) 
    45 
    5 ================ 
    6 NEMO Ocean Model 
    7 ================ 
    8  
    9 NEMO_ (Nucleus for European Modelling of the Ocean) is a state-of-the-art modelling framework of  
     6NEMO for *Nucleus for European Modelling of the Ocean* is a state-of-the-art modelling framework of  
    107ocean related engines for oceanographic research, operational oceanography, seasonal forecast and  
    118[paleo]climate studies. 
    129 
    13 The NEMO ocean model has 3 major components: 
     10Overview 
     11======== 
     12 
     13Distributed under CeCILL license (GNU GPL compatible - see ``./LICENSE``), 
     14the NEMO ocean model has 3 major components: 
    1415 
    1516- :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. 
     17  solving the primitive equations         (``./src/OCE``);  
     18- :rstgrey:`SI`\ :rstgreysup:`3` for sea-ice simulates ice [thermo]dynamics, brine inclusions and  
     19  subgrid-scale thickness variations      (``./src/ICE``);  
     20- :rstgreen:`TOP-PISCES` models biogeochemistry with TOP for the on/offline oceanic tracers transport and  
     21  PISCES for the biogeochemical processes (``./src/MBG``). 
    2122 
    22 These physical engines are described in their respective `reference publications`_. 
     23These physical engines are described in their respective reference publications that must be cited for  
     24any work related to their use. 
    2325 
    24 They are complemented by a 2-way nesting software (AGRIF_) and  
    25 a versatile data assimilation interface with 3 different modules 
    26 (linear-tangent TAM, observational operators OBS, and increment ASM). 
     26Applications and capabilities 
     27============================= 
    2728 
    28 ------------ 
    29 Applications 
    30 ------------ 
     29Not only does the NEMO framework model the ocean circulation, 
     30it offers various features to enable 
    3131 
    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. 
     32- 2-way nesting package `AGRIF`_ to create embedded zooms seamlessly 
     33- Flexible biogeomchemistry with online coarsening and possible integration of a customized model  
     34- Versatile data assimilation interface with 3 different modules 
     35  (tangent linear, observational operators and increments) 
    3736 
    38 A set of tools is also provided to setup your own configuration and  
    39 [pre|post]process your data (``./tools``). 
     37lation a efficient XIOS_ server for outputing diagnostics a coupled via OASIS_ to alternative components or other models to enable Earth system modelling. 
    4038 
    41 ------- 
    42 Options 
    43 ------- 
     39| Several builtins configurations are provided to assess the skills and performances of the model which 
     40   can be used as templates for setting up a new configuration (``./cfgs``). 
     41| The end user could also find some idealised test cases on the web to serve as examples and 
     42   to study particular processes (``./tests``). 
    4443 
    45 For writing diagnostics in a efficient way, NEMO make use of XIOS_ server which  
    46 controlled the outputs using XML input file. 
     44A set of tools is also provided to setup your own configuration and [pre|post]process your data (``./tools``). 
    4745 
    48 To enable Earth system modelling, NEMO can be interfaced via  
    49 OASIS_ coupleur to external components such as atmospheric models or  
    50 alternative models of sea-ice or biogeochemistry. 
     46Literature 
     47========== 
    5148 
    52 ------------- 
    53 Documentation 
    54 ------------- 
     49| The NEMO reference manual and a quick start guide can be generated from Latex and RST source code files 
     50   (``./doc``), either in PDF or in HTML format, but it might require some additional installations. 
     51| In any case, both formats are available online: `HTML`_ | `PDF`_ 
    5552 
    56 The NEMO reference manual can be generated from the LaTeX source code (``./doc``),  
    57 either in PDF or in HTML format, but it mights require some additionnal installations. 
     53| Since 2014 the project has a `Special Issue`_ in the Geoscientific Model Development (GMD) open-access journal 
     54   from the European Geosciences Union (EGU). 
     55   The main scope is to collect relevant manuscripts which cover a wide variety of topics like 
     56   process studies, new parameterizations, implementation of new model features and new NEMO configurations. 
     57| Also it provides a single portal to search, discover and understand about 
     58   the NEMO modelling framework potential and evolution and to submit their contributions.  
    5859 
    59 In any case, both formats are available online on the `NEMO website`__. 
    60  
    61 --------------------- 
    6260Community development 
    63 --------------------- 
     61===================== 
    6462 
    6563| 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. 
     64   keep a reliable evolving system since 2008. 
     65| It defines the multi-year development strategy which is implemented by the NEMO System Team. 
    6866 
    69 -------- 
    70 Acronyms 
    71 -------- 
     67`Working groups`_ are regularly created or resumed to gather the expertise in the NEMO community in order to  
     68focus the development work on a specific subject or major component of NEMO. 
     69 
     70Definitions 
     71=========== 
    7272 
    7373AGRIF 
    74  Adaptive Grid Refinement In Fortran 
     74   *Adaptive Grid Refinement In Fortran*,  
     75   package for the integration of full adaptive mesh refinement features within  
     76   an existing multidimensional finite difference model 
    7577 
    76 LIM 
    77  Louvain-la-Neuve Ice Model 
     78SI\ :sup:`3`\  
     79   *Sea Ice Integrated Initiative*,  
     80   unified sea ice model merging functionalities from CICE, GELATO and LIM into the NEMO framework 
    7881 
    79 OPA 
    80  "Océan PArallélisé" (french) 
     82OASIS 
     83   *Ocean Atmosphere Sea Ice Soil*,  
     84   coupling software to synchronise numerical codes representing different components of the climate system 
    8185 
    8286PISCES 
    83  Pelagic Interactions Scheme for Carbon and Ecosystem Studies 
     87   *Pelagic Interactions Scheme for Carbon and Ecosystem Studies*,  
     88   biogeochemical model simulating marine ecosystems, cycles of carbon and the main nutrients 
    8489 
    8590TAM 
    86  Tangent Adjoint Model 
     91   *Tangent linear and Adjoint Model*,  
     92   tools to analyse and control the NEMO dynamical core for a wide range of applications such as 
     93   sensitivity analysis, parameter estimation, vectors computation or data assimilation. 
    8794 
    8895TOP 
    89  Tracers in Ocean Paradigm 
     96   *Tracers in Ocean Paradigm*,  
     97   on/off-line oceanic tracers transport and biogeochemistry models 
    9098 
    9199XIOS 
    92  XML Input Output Server 
     100   *XML Input Output Server*,  
     101   library dedicated to input/output management of climate code 
    93102 
    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_ 
     103.. _AGRIF:          http://agrif.imag.fr 
     104.. _HTML:           http://www.nemo-ocean.eu/doc 
     105.. _NEMO:           http://www.nemo-ocean.eu 
     106.. _OASIS:          http://verc.enes.org/oasis 
     107.. _PDF:            http://www.nemo-ocean.eu/wp-content/uploads/NEMO_book.pdf 
     108.. _Special Issue:  http://www.geosci-model-dev.net/special_issue40.html 
     109.. _Working groups: http://forge.ipsl.jussieu.fr/nemo/wiki/WorkingGroups 
     110.. _XIOS:           http://forge.ipsl.jussieu.fr/ioserver 
Note: See TracChangeset for help on using the changeset viewer.