Changeset 10602


Ignore:
Timestamp:
2019-01-28T22:58:17+01:00 (15 months ago)
Author:
nicolasmartin
Message:

Review global README and the layout of the guide
Gather release notes, contributing and definitions in Miscellaneous TOC entry

Location:
NEMO/trunk
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • NEMO/trunk/README.rst

    r10596 r10602  
    1 NEMO_ 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, 
     1:Release: |version| 
     2:Date:    |today| 
     3 
     4NEMO_ for **Nucleus for European Modelling of the Ocean** is a state-of-the-art modelling framework for 
     5research activities and forecasting services in ocean and climate sciences, 
    26developed in a sustainable way by a European consortium since 2008. 
     7 
     8.. contents:: 
     9   :local: 
    310 
    411Overview 
    512======== 
    613 
    7 The NEMO_ ocean model has 3 major components: 
     14The NEMO ocean model has 3 major components: 
    815 
    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``) 
     16- |OPA| models the ocean {thermo}dynamics and solves the primitive equations 
     17  (``./src/OCE``) 
     18- |SI3| simulates seaice {thermo}dynamics, brine inclusions and subgrid-scale thickness variations 
     19  (``./src/ICE``) 
     20- |TOP| models the {on,off}line oceanic tracers transport and biogeochemical processes 
     21  (``./src/TOP``) 
    1222 
    13 These physical core engines are described in their respective `reference documentation`_ that must be cited for any work related to their use. 
     23These physical core engines are described in their respective `references`_ that 
     24must be cited for any work related to their use. 
    1425 
    15 Assets and ready-to-use solutions 
    16 ================================= 
     26Assets and solutions 
     27==================== 
    1728 
    18 Not only does the NEMO_ framework model the ocean circulation, it offers various features to enable 
     29Not only does the NEMO framework model the ocean circulation, 
     30it offers various features to enable 
    1931 
    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_ 
     32- Create :doc:`embedded zooms<zooms>` seamlessly thanks to 2-way nesting package AGRIF_. 
     33- Opportunity to integrate an :doc:`external biogeochemistry model<tracers>` 
     34- Versatile :doc:`data assimilation<data_assimilation>` 
     35- Generation of :doc:`diagnostics<diagnostics>` through effective XIOS_ system 
     36- Roll-out Earth system modeling with :doc:`coupling interface<coupling>` based on OASIS_ 
    2537 
    26 Several 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``). 
     38Several :doc:`built-in configurations<configurations>` are provided to 
     39evaluate the skills and performances of the model which 
     40can be used as templates for setting up a new configurations (``./cfgs``). 
    2741 
    28 NEMO user can also checkout available idealized test cases that address specific physical processes(``./tests``). 
     42The user can also checkout available :doc:`idealized test cases<test_cases>` that 
     43address specific physical processes(``./tests``). 
    2944 
    30 A set of utilities is also provided to {pre,post}process your data (``./tools``). 
     45A set of :doc:`utilities <tools>` is also provided to {pre,post}process your data (``./tools``). 
    3146 
    32 Documentation and references 
    33 ============================ 
     47Project documentation 
     48===================== 
    3449 
    35 A walkthrough tutorial illustrates how to get code dependencies, compile and execute NEMO (``./INSTALL.rst``) .  
     50A walkthrough tutorial illustrates how to get code dependencies, compile and execute NEMO 
     51(``./INSTALL.rst``) .  
    3652 
    37 Reference 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. 
     53Reference manuals and quick start guide can be build from source and 
     54exported to HTML or PDF formats (``./doc``) or 
     55downloaded directly from the :website:`website<bibliography/documentation>`. 
    3856 
    39 =========== =================== =================== 
    40  Component    Reference Manual   Quick start 
    41 =========== =================== =================== 
    42  OCE          `NEMO manual`_     `NEMO guide`_ 
    43  SI3          `SI3 manual`_ 
    44  TOP          `TOP manual`_       
    45 =========== =================== =================== 
     57=========== ===================== =============== 
     58 Component   Reference Manual      Quick start 
     59=========== ===================== =============== 
     60 |OPA|       |NEMO manual|_        |NEMO guide|_ 
     61             :cite:`NEMO_manual` 
     62 |SI3|       |SI3 manual|_ 
     63             :cite:`SI3_manual` 
     64 |TOP|       |TOP manual|_ 
     65             :cite:`TOP_manual` 
     66=========== ===================== =============== 
    4667 
    47 Since 2014 the project has a `Special Issue`_ in the open-access journal Geoscientific Model Development (GMD) from the European Geosciences Union (EGU). 
    48 The main scope is to collect relevant manuscripts covering various topics and to provide a single portal to assess the model potential and evolution. 
     68Since 2014 the project has a `Special Issue`_ in the open-access journal 
     69Geoscientific Model Development (GMD) from the European Geosciences Union (EGU). 
     70The main scope is to collect relevant manuscripts covering various topics and 
     71to provide a single portal to assess the model potential and evolution. 
    4972 
    50 Used by a wide audience, numerous `associated projects`_ have been carried out and extensive `bibliography`_ published. 
     73Used by a wide audience, 
     74numerous :website:`associated projects<projects>` have been carried out and 
     75extensive :website:`bibliography<bibliography/publications>` published. 
    5176 
    52 NEMO Consortium 
    53 =============== 
     77Development board 
     78================= 
    5479 
    55 The 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. 
     80The NEMO Consortium pulling together 5 European institutes (CMCC_, CNRS_, MOI_, `Met Office`_ and NERC_) 
     81plans the sustainable development in order to keep a reliable evolving framework since 2008. 
    5682 
    57 It 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. 
     83It defines the |NEMO strategy|_ that is implemented by the System Team on a yearly basis in order to 
     84release a new version almost every four years. 
    5885 
    59 When the need arises, `working groups`_ are created or resumed to gather the community expertise for advising on the development activities. 
     86When the need arises, :forge:`working groups<wiki/WorkingGroups>` are created or resumed to 
     87gather the community expertise for advising on the development activities. 
    6088 
    61 ..  _external biogeochemistry model : http://forge.ipsl.jussieu.fr/nemo/wiki/WorkingGroups/TOP/TOP-UserQuickGuide 
    62 .. _working groups : https://forge.ipsl.jussieu.fr/nemo/wiki/WorkingGroups 
    63 .. _reference documentation : https://www.nemo-ocean.eu/bibliography/documentation/ 
    64 .. _Special Issue : http://www.geosci-model-dev.net/special_issue40.html 
    65 .. _associated projects : https://www.nemo-ocean.eu/projects/ 
    66 .. _bibliography : https://www.nemo-ocean.eu/wp-content/plugins/wp-bibtexbrowser/bibtexbrowser.php?bib=nemo.bib 
     89 
     90.. Substitutions / Links 
     91 
     92.. |NEMO manual| image:: http://zenodo.org/badge/DOI/10.5281/zenodo.1464816.svg 
     93.. |NEMO guide|  image:: http://zenodo.org/badge/DOI/10.5281/zenodo.1475325.svg 
     94.. |SI3 manual|  image:: http://zenodo.org/badge/DOI/10.5281/zenodo.1471689.svg 
     95.. |TOP manual|  image:: http://zenodo.org/badge/DOI/10.5281/zenodo.1471700.svg 
     96 
     97.. |NEMO strategy| replace:: multi-year development strategy 
     98 
     99.. _Special Issue: http://www.geosci-model-dev.net/special_issue40.html 
  • NEMO/trunk/doc/rst/source/NEMO_guide.rst

    r10600 r10602  
    1414   'global.rst' contains a list of common directives (roles, substitutions and URL links) 
    1515   It is loaded for each file thanks to 'rst_epilog' setting in 'conf.py' 
    16  
    17 .. toctree:: 
    18    :hidden: 
    19  
    20    release_notes 
    2116 
    2217.. toctree:: 
     
    4742.. toctree:: 
    4843   :hidden: 
    49    :caption: Contributions are welcome! 
     44   :caption: Miscellaneous 
    5045 
    5146   contributing 
    52  
    53 .. toctree:: 
    54    :hidden: 
    55    :caption: Glossary 
    56  
    57    definitions 
     47   release_notes 
     48   Glossary<definitions> 
    5849 
    5950.. include:: readme.rst 
     
    6152.. Next headings markup acording to readme.rst 
    6253 
    63 Reference publications 
    64 ====================== 
     54References 
     55========== 
    6556 
    6657.. bibliography:: references.bib 
Note: See TracChangeset for help on using the changeset viewer.