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 10551 – NEMO

Changeset 10551


Ignore:
Timestamp:
2019-01-18T17:24:38+01:00 (5 years ago)
Author:
lovato
Message:

Update content of root README.rst

File:
1 edited

Legend:

Unmodified
Added
Removed

  • NEMO/trunk/README.rst

    r10460 r10551  
    1 :Release: |release| 
    2 :Date:    |today| 
    3  
    4 `NEMO`_ for *Nucleus for European Modelling of the Ocean* is a state-of-the-art modelling framework, 
    5 for research activities and forecasting services in ocean and climate sciences, 
     1NEMO_ for **Nucleus for European Modelling of the Ocean** is a state-of-the-art modelling framework for research activities and forecasting services in ocean and climate sciences, 
    62developed in a sustainable way by a European consortium since 2008. 
    7  
    8 .. contents:: 
    9    :local: 
    103 
    114Overview 
    125======== 
    136 
    14 The NEMO ocean model has 3 major components: 
     7The NEMO_ ocean model has 3 major components: 
    158 
    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`. 
     9- **OCE** models the ocean [thermo]dynamics and solves the primitive equations (``./src/OCE``) 
     10- **SI3** simulates seaice [thermo]dynamics, brine inclusions and subgrid-scale thickness variations (``./src/ICE``) 
     11- **TOP** models the [on|off]line oceanic tracers transport and biogeochemical processes (``./src/TOP``) 
    2212 
    23 These physical core engines are described in their respective `reference publications`_, 
    24 that must be cited for any work related to their use. 
     13These physical core engines are described in their respective `reference documentation`_ that must be cited for any work related to their use. 
    2514 
    2615Assets and ready-to-use solutions 
    2716================================= 
    2817 
    29 Not only does the NEMO framework model the ocean circulation, 
    30 it offers various features to enable 
     18Not only does the NEMO_ framework model the ocean circulation, it offers various features to enable 
    3119 
    32 - Create :doc:`embedded zooms <zooms>` seamlessly thanks to 2-way nesting package `AGRIF`_. 
    33 - Opportunity to integrate an :doc:`alternative biogeochemistry model <tracers>` 
    34 - Versatile :doc:`data_assimilation <data assimilation>`. 
    35 - Generation of :doc:`diagnostics <diagnostics>` through effective `XIOS`_ server. 
    36 - Roll-out Earth system modelling with :doc:`coupling interface <coupling>` to `OASIS`_. 
     20- Create embedded zoom seamlessly thanks to 2-way nesting package AGRIF_. 
     21- Opportunity to integrate an `external biogeochemistry model`_  
     22- Versatile data_assimilation (``./src/OBS``) 
     23- Generation of diagnostics through effective XIOS_ system 
     24- Roll-out Earth system modeling with coupling interface based on OASIS_ 
    3725 
    38 | Several :doc:`built-in configurations <configurations>` are provided to evaluate 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 online some :doc:`idealised test cases <test_cases>` to serve as templates and 
    41    to study particular processes (``./tests``). 
     26Several built-in configurations are provided to evaluate the skills and performances of the model which can be used as templates for setting up a new configurations (``./cfgs``). 
    4227 
    43 A set of :doc:`utilities <tools>` is also provided to [pre|post]process your data (``./tools``). 
     28NEMO user can also checkout available idealized test cases that address specific physical processes(``./tests``). 
    4429 
    45 Project literature 
    46 ================== 
     30A set of utilities is also provided to [pre|post]process your data (``./tools``). 
    4731 
    48 A tutorial  
    49 :doc:`install` 
     32Documentation and references 
     33============================ 
    5034 
    51 The reference documentation is archived online 
     35A walkthrough tutorial illustrates how to get code dependencies, compile and execute NEMO (``./INSTALL.rst``) .  
    5236 
    53 +-------+-------------------+----------------+ 
    54 |       | Reference manual  | |NEMO manual|_ | 
    55 | |OPA| +-------------------+----------------+ 
    56 |       | Quick start guide | |NEMO guide|_  | 
    57 +-------+-------------------+----------------+ 
    58 | |SI3|                     | |SI3 manual|_  | 
    59 +---------------------------+----------------+ 
    60 | |TOP|                     | |TOP manual|_  | 
    61 +---------------------------+----------------+ 
     37Reference manuals and quick start guide can be build from source and exported to HTML or PDF formats (``./doc``) or downloaded directly from the NEMO_ website. 
    6238 
    63 .. |NEMO manual| image:: http://zenodo.org/badge/DOI/10.5281/zenodo.1464816.svg 
    64 .. |NEMO guide|  image:: http://zenodo.org/badge/DOI/10.5281/zenodo.1475325.svg 
    65 .. |SI3 manual|  image:: http://zenodo.org/badge/DOI/10.5281/zenodo.1471689.svg 
    66 .. |TOP manual|  image:: http://zenodo.org/badge/DOI/10.5281/zenodo.1471700.svg 
     39=========== =================== =================== 
     40 Component    Reference Manual   Quick start 
     41=========== =================== =================== 
     42 OCE          `NEMO manual`_     `NEMO guide`_ 
     43 SI3          `SI3 manual`_ 
     44 TOP          `TOP manual`_       
     45=========== =================== =================== 
    6746 
    68 | Reference manuals and quick start guide can be build from source and exported to HTML or PDF (``./doc``). 
    69 | In any case, one can find them online: 
     47Since 2014 the project has a `Special Issue`_ in the open-access journal Geoscientific Model Development (GMD) from the European Geosciences Union (EGU). 
     48The main scope is to collect relevant manuscripts covering various topics and to provide a single portal to assess the model potential and evolution. 
    7049 
    71 Since 2014 the project has a `Special Issue <http://www.geosci-model-dev.net/special_issue40.html>`_ in 
    72 the open-access journal Geoscientific Model Development (GMD) from the European Geosciences Union (EGU). 
    73 The main scope is to collect relevant manuscripts covering various topics and to provide a single portal to 
    74 assess the model potential and evolution. 
     50Used by a wide audience, numerous `associated projects`_ have been carried out and extensive `bibliography`_ published. 
    7551 
    76 Used by a wide audience, numerous :website:`associated projects <projects>` have been carried out and 
    77 extensive :website:`bibliography <bibliography/publications>` published. 
     52NEMO Consortium 
     53=============== 
    7854 
    79 Collaborative development 
    80 ========================= 
     55The NEMO Consortium pulling together 5 European institutes (CMCC_, CNRS_, MOI_, `Met Office`_ and NERC_)        plans the sustainable development in order to keep a reliable evolving framework since 2008. 
    8156 
    82 | The NEMO Consortium pulling together 5 European institutes (`CMCC`_, `CNRS`_, `MOI`_, `Met Office`_ and `NERC`_) 
    83    plans the sustainable development in order to keep a reliable evolving framework since 2008. 
    84 | It defines the |NEMO strategy|_ which is implemented by the System Team on 
    85    a yearly basis in order to release a new version almost every four years. 
     57It defines the NEMO strategy that is implemented by the System Team on a yearly basis in order to release a new version almost every four years. 
    8658 
    87 .. |NEMO strategy| replace:: multi-year development strategy 
     59When the need arises, `working groups`_ are created or resumed to gather the community expertise for advising on the development activities. 
    8860 
    89 When the need arises, :forge:`working groups <wiki/WorkingGroups>` are created or resumed to 
    90 gather the community expertise for advising on the development activities. 
     61..  _external biogeochemistry model : http://forge.ipsl.jussieu.fr/nemo/wiki/WorkingGroups/TOP/TOP-UserQuickGuide 
     62.. _NEMO : https://www.nemo-ocean.eu/ 
     63.. _OASIS : https://portal.enes.org/oasis 
     64.. _XIOS : http://forge.ipsl.jussieu.fr/ioserver 
     65.. _AGRIF : https://www-ljk.imag.fr/MOISE/AGRIF/ 
     66.. _working groups : https://forge.ipsl.jussieu.fr/nemo/wiki/WorkingGroups 
     67.. _reference documentation : https://www.nemo-ocean.eu/bibliography/documentation/ 
     68.. _Special Issue : http://www.geosci-model-dev.net/special_issue40.html 
     69.. _associated projects : https://www.nemo-ocean.eu/projects/ 
     70.. _bibliography : https://www.nemo-ocean.eu/wp-content/plugins/wp-bibtexbrowser/bibtexbrowser.php?bib=nemo.bib 
     71.. _CMCC : https://www.cmcc.it/ 
     72.. _CNRS : http://www.cnrs.fr/ 
     73.. _MOI : https://www.mercator-ocean.fr 
     74.. _Met Office : https://www.metoffice.gov.uk/ 
     75.. _NERC : https://nerc.ukri.org/ 
     76.. _`NEMO manual` : http://zenodo.org/badge/DOI/10.5281/zenodo.1464816.svg 
     77.. _`NEMO guide` : http://zenodo.org/badge/DOI/10.5281/zenodo.1475325.svg 
     78.. _`SI3 manual` : http://zenodo.org/badge/DOI/10.5281/zenodo.1471689.svg 
     79.. _`TOP manual` : http://zenodo.org/badge/DOI/10.5281/zenodo.1471700.svg 
    9180 
    92 :doc:`<contributing>` 
Note: See TracChangeset for help on using the changeset viewer.