Ignore:
Timestamp:
2018-11-21T11:25:53+01:00 (2 years ago)
Author:
smasson
Message:

dev_r10164_HPC09_ESIWACE_PREP_MERGE: merge with trunk@10344, see #2133

File:
1 edited

Legend:

Unmodified
Added
Removed
  • NEMO/branches/2018/dev_r10164_HPC09_ESIWACE_PREP_MERGE/README.rst

    r9650 r10345  
    1 .. role:: rstblue 
    2 .. role:: rstgrey 
    3 .. role:: rstgreen 
     1:Authors: NEMO System Team 
     2:Release: |release| 
     3:Date:    |today| 
    44 
    5 ================ 
    6 NEMO Ocean Model 
    7 ================ 
     5`NEMO`_ for *Nucleus for European Modelling of the Ocean* is a state-of-the-art modelling framework for 
     6research activities and forecasting services in ocean and climate sciences. 
    87 
    9 NEMO_ (Nucleus for European Modelling of the Ocean) is a state-of-the-art modelling framework of  
    10 ocean related engines for oceanographic research, operational oceanography, seasonal forecast and  
    11 [paleo]climate studies. 
     8.. contents:: 
     9   :local: 
     10 
     11Overview 
     12======== 
    1213 
    1314The NEMO ocean model has 3 major components: 
    1415 
    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. 
     16- |OPA| models the ocean [thermo]dynamics and solves the primitive equations 
     17  (``./src/OCE``) :cite:`NEMO_manual`; 
     18- |SI3| simulates ice [thermo]dynamics, brine inclusions and subgrid-scale thickness variations 
     19  (``./src/ICE``) :cite:`SI3_manual`; 
     20- |TOP| models the [on|off]line oceanic tracers transport and the biogeochemical processes 
     21  (``./src/MBG``) :cite:`TOP_manual`. 
    2122 
    22 These physical engines are described in their respective `reference publications`_. 
     23These physical core 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- Create :doc:`embedded zooms <zooms>` seamlessly with 2-way nesting package `AGRIF`_. 
     33- :doc:`Low cost biogeochemistry <coarsening>` and :doc:`alternative model opportunity <tracers>`. 
     34- Versatile :doc:`assimilation <assimilation>`. 
     35- :doc:`Output diagnostics <diagnostics>` with `XIOS`_ server. 
     36- :doc:`Coupling <coupling>` via `OASIS`_ for Earth system modelling. 
    3737 
    38 A set of tools is also provided to setup your own configuration and  
    39 [pre|post]process your data (``./tools``). 
     38| Several :doc:`builtins configurations <configurations>` are provided to assess the skills and performances of 
     39   the model which can be used as templates for :doc:`setting up a new configuration <setup>` (``./cfgs``). 
     40| The end user could also find some :doc:`idealised test cases <test_cases>` online to serve as templates and 
     41   to study particular processes (``./tests``). 
    4042 
    41 ------- 
    42 Options 
    43 ------- 
     43A set of :doc:`utilities <tools>` is also provided to [pre|post]process your data (``./tools``). 
    4444 
    45 For writing diagnostics in a efficient way, NEMO make use of XIOS_ server which  
    46 controlled the outputs using XML input file. 
     45Literature 
     46========== 
    4747 
    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. 
     48:doc:`install` 
    5149 
    52 ------------- 
    53 Documentation 
    54 ------------- 
     50The reference documentation is archived online 
    5551 
    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. 
     52+-------+-------------------+----------------+ 
     53|       | Reference manual  | |NEMO manual|_ | 
     54| |OPA| +-------------------+----------------+ 
     55|       | Quick start guide | |NEMO guide|_  | 
     56+-------+-------------------+----------------+ 
     57| |SI3|                     | |SI3 manual|_  | 
     58+---------------------------+----------------+ 
     59| |TOP|                     | |TOP manual|_  | 
     60+---------------------------+----------------+ 
    5861 
    59 In any case, both formats are available online on the `NEMO website`__. 
     62.. |NEMO manual| image:: http://zenodo.org/badge/DOI/10.5281/zenodo.1464816.svg 
     63.. |NEMO guide|  image:: http://zenodo.org/badge/DOI/10.5281/zenodo.1475325.svg 
     64.. |SI3 manual|  image:: http://zenodo.org/badge/DOI/10.5281/zenodo.1471689.svg 
     65.. |TOP manual|  image:: http://zenodo.org/badge/DOI/10.5281/zenodo.1471700.svg 
    6066 
    61 --------------------- 
     67| Reference manuals and quick start guide can be build from source and exported to HTML or PDF (``./doc``). 
     68| In any case, one can find them online: 
     69 
     70Since 2014 the project has a `Special Issue <http://www.geosci-model-dev.net/special_issue40.html>`_ in 
     71the open-access journal Geoscientific Model Development (GMD) from the European Geosciences Union (EGU). 
     72The main scope is to collect relevant manuscripts covering various topics and to provide a single portal to 
     73assess the model potential and evolution. 
     74 
     75Used by a wide audience, numerous :website:`associated projects <projects>` have been carried out and 
     76extensive :website:`bibliography <bibliography/publications>` published. 
     77 
    6278Community development 
    63 --------------------- 
     79===================== 
    6480 
    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. 
     81| The NEMO Consortium pulling together 5 European institutes (`CMCC`_, `CNRS`_, `MOI`_, `Met Office`_ and `NERC`_) 
     82   plans the sustainable development in order to keep a reliable evolving framework since 2008. 
     83| It defines the |NEMO strategy|_ which is implemented by the System Team on 
     84   a yearly basis in order to release a new version almost every four years. 
    6885 
    69 -------- 
    70 Acronyms 
    71 -------- 
     86.. |NEMO strategy| replace:: multi-year development strategy 
    7287 
    73 AGRIF 
    74  Adaptive Grid Refinement In Fortran 
    75  
    76 LIM 
    77  Louvain-la-Neuve Ice Model 
    78  
    79 OPA 
    80  "Océan PArallélisé" (french) 
    81  
    82 PISCES 
    83  Pelagic Interactions Scheme for Carbon and Ecosystem Studies 
    84  
    85 TAM 
    86  Tangent Adjoint Model 
    87  
    88 TOP 
    89  Tracers in Ocean Paradigm 
    90  
    91 XIOS 
    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_ 
     88When the need arises, :forge:`working groups <wiki/WorkingGroups>` are created or resumed to 
     89gather the community expertise for advising on the development activities. 
Note: See TracChangeset for help on using the changeset viewer.