Changeset 10460


Ignore:
Timestamp:
2019-01-07T16:29:28+01:00 (21 months ago)
Author:
nicolasmartin
Message:

Small modifications regarding README(s) and ReST files

Location:
NEMO/trunk
Files:
1 added
2 deleted
8 edited
1 moved

Legend:

Unmodified
Added
Removed
  • NEMO/trunk/README.rst

    r10279 r10460  
    1 :Authors: NEMO System Team 
    21:Release: |release| 
    32:Date:    |today| 
    43 
    5 `NEMO`_ for *Nucleus for European Modelling of the Ocean* is a state-of-the-art modelling framework for 
    6 research activities and forecasting services in ocean and climate sciences. 
     4`NEMO`_ for *Nucleus for European Modelling of the Ocean* is a state-of-the-art modelling framework, 
     5for research activities and forecasting services in ocean and climate sciences, 
     6developed in a sustainable way by a European consortium since 2008. 
    77 
    88.. contents:: 
     
    2121  (``./src/MBG``) :cite:`TOP_manual`. 
    2222 
    23 These physical core engines are described in their respective <reference publications> that must be cited for 
    24 any work related to their use. 
     23These physical core engines are described in their respective `reference publications`_, 
     24that must be cited for any work related to their use. 
    2525 
    26 Applications and capabilities 
    27 ============================= 
     26Assets and ready-to-use solutions 
     27================================= 
    2828 
    2929Not only does the NEMO framework model the ocean circulation, 
    3030it offers various features to enable 
    3131 
    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. 
     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`_. 
    3737 
    38 | Several :doc:`builtins configurations <configurations>` are provided to assess the skills and performances of 
     38| Several :doc:`built-in configurations <configurations>` are provided to evaluate the skills and performances of 
    3939   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 
     40| The end user could also find online some :doc:`idealised test cases <test_cases>` to serve as templates and 
    4141   to study particular processes (``./tests``). 
    4242 
    4343A set of :doc:`utilities <tools>` is also provided to [pre|post]process your data (``./tools``). 
    4444 
    45 Literature 
    46 ========== 
     45Project literature 
     46================== 
    4747 
     48A tutorial  
    4849:doc:`install` 
    4950 
     
    7677extensive :website:`bibliography <bibliography/publications>` published. 
    7778 
    78 Community development 
    79 ===================== 
     79Collaborative development 
     80========================= 
    8081 
    8182| The NEMO Consortium pulling together 5 European institutes (`CMCC`_, `CNRS`_, `MOI`_, `Met Office`_ and `NERC`_) 
     
    8889When the need arises, :forge:`working groups <wiki/WorkingGroups>` are created or resumed to 
    8990gather the community expertise for advising on the development activities. 
     91 
     92:doc:`<contributing>` 
  • NEMO/trunk/cfgs/AGRIF_DEMO/README.rst

    r10279 r10460  
    1 ********************** 
    2 Embedded zooms (AGRIF) 
    3 ********************** 
     1************** 
     2Embedded zooms 
     3************** 
    44 
    55.. contents:: 
  • NEMO/trunk/cfgs/README.rst

    r10279 r10460  
    1 ***************************** 
    2 Run a reference configuration 
    3 ***************************** 
     1*************************** 
     2Run built-in configurations 
     3*************************** 
    44 
    55.. contents:: 
     
    1414| :underline:`The NEMO System Team is in charge of these configurations`. 
    1515 
    16 +----------------------+-----+-----+-----+--------+-------+-------------------------------+ 
    17 |                      | OPA | SI3 | TOP | PISCES | AGRIF | Inputs                        | 
    18 +======================+=====+=====+=====+========+=======+===============================+ 
    19 | `AGRIF_DEMO`_        |  X  |  X  |     |        |   X   | - `AGRIF_DEMO_v4.0.tar`_      | 
    20 |                      |     |     |     |        |       | - `ORCA2_ICE_v4.0.tar`_       | 
    21 +----------------------+-----+-----+-----+--------+-------+-------------------------------+ 
    22 | `AMM12`_             |  X  |     |     |        |       | `AMM12_v4.0.tar`_             | 
    23 +----------------------+-----+-----+-----+--------+-------+-------------------------------+ 
    24 | `C1D_PAPA`_          |  X  |     |     |        |       | `INPUTS_C1D_PAPA_v4.0.tar`_  | 
    25 +----------------------+-----+-----+-----+--------+-------+-------------------------------+ 
    26 | `GYRE_BFM`_          |  X  |     |  X  |        |       | ``-``                         | 
    27 +----------------------+-----+-----+-----+--------+-------+-------------------------------+ 
    28 | `GYRE_PISCES`_       |  X  |     |  X  |   X    |       | ``-``                         | 
    29 +----------------------+-----+-----+-----+--------+-------+-------------------------------+ 
    30 | `ORCA2_ICE_PISCES`_  |  X  |  X  |  X  |   X    |       | - `ORCA2_ICE_v4.0.tar`_       | 
    31 |                      |     |     |     |        |       | - `INPUTS_PISCES_v4.0.tar`_  | 
    32 +----------------------+-----+-----+-----+--------+-------+-------------------------------+ 
    33 | `ORCA2_OFF_PISCES`_  |     |     |  X  |   X    |       | - `INPUTS_PISCES_v4.0.tar`_  | 
    34 |                      |     |     |     |        |       | - `ORCA2_OFF_v4.0.tar`_       | 
    35 +----------------------+-----+-----+-----+--------+-------+-------------------------------+ 
    36 | `ORCA2_OFF_TRC`_     |     |     |  X  |        |       | `ORCA2_OFF_v4.0.tar`_         | 
    37 +----------------------+-----+-----+-----+--------+-------+-------------------------------+ 
    38 | `ORCA2_SAS_ICE`_     |     |  X  |     |        |       | - `ORCA2_ICE_v4.0.tar`_       | 
    39 |                      |     |     |     |        |       | - `INPUTS_SAS_v4.0.tar`_      | 
    40 +----------------------+-----+-----+-----+--------+-------+-------------------------------+ 
    41 | `SPITZ12`_           |  X  |  X  |     |        |       | `SPITZ12_v4.0.tar`_           | 
    42 +----------------------+-----+-----+-----+--------+-------+-------------------------------+ 
     16+----------------------+-----+-----+-----+--------+-------+--------------------------+ 
     17|                      | OPA | SI3 | TOP | PISCES | AGRIF | Inputs                   | 
     18+======================+=====+=====+=====+========+=======+==========================+ 
     19| `AGRIF_DEMO`_        |  X  |  X  |     |        |   X   | - AGRIF_DEMO_v4.0.tar    | 
     20|                      |     |     |     |        |       | - ORCA2_ICE_v4.0.tar     | 
     21+----------------------+-----+-----+-----+--------+-------+--------------------------+ 
     22| `AMM12`_             |  X  |     |     |        |       | AMM12_v4.0.tar           | 
     23+----------------------+-----+-----+-----+--------+-------+--------------------------+ 
     24| `C1D_PAPA`_          |  X  |     |     |        |       | INPUTS_C1D_PAPA_v4.0.tar | 
     25+----------------------+-----+-----+-----+--------+-------+--------------------------+ 
     26| `GYRE_BFM`_          |  X  |     |  X  |        |       | ``-``                    | 
     27+----------------------+-----+-----+-----+--------+-------+--------------------------+ 
     28| `GYRE_PISCES`_       |  X  |     |  X  |   X    |       | ``-``                    | 
     29+----------------------+-----+-----+-----+--------+-------+--------------------------+ 
     30| `ORCA2_ICE_PISCES`_  |  X  |  X  |  X  |   X    |       | - ORCA2_ICE_v4.0.tar     | 
     31|                      |     |     |     |        |       | - INPUTS_PISCES_v4.0.tar | 
     32+----------------------+-----+-----+-----+--------+-------+--------------------------+ 
     33| `ORCA2_OFF_PISCES`_  |     |     |  X  |   X    |       | - INPUTS_PISCES_v4.0.tar | 
     34|                      |     |     |     |        |       | - ORCA2_OFF_v4.0.tar     | 
     35+----------------------+-----+-----+-----+--------+-------+--------------------------+ 
     36| `ORCA2_OFF_TRC`_     |     |     |  X  |        |       | ORCA2_OFF_v4.0.tar       | 
     37+----------------------+-----+-----+-----+--------+-------+--------------------------+ 
     38| `ORCA2_SAS_ICE`_     |     |  X  |     |        |       | - ORCA2_ICE_v4.0.tar     | 
     39|                      |     |     |     |        |       | - INPUTS_SAS_v4.0.tar    | 
     40+----------------------+-----+-----+-----+--------+-------+--------------------------+ 
     41| `SPITZ12`_           |  X  |  X  |     |        |       | SPITZ12_v4.0.tar         | 
     42+----------------------+-----+-----+-----+--------+-------+--------------------------+ 
    4343 
    4444AGRIF_DEMO 
  • NEMO/trunk/cfgs/SHARED/README.rst

    r10279 r10460  
    1 ****************** 
    2 Diagnostics (XIOS) 
    3 ****************** 
     1*********** 
     2Diagnostics 
     3*********** 
    44 
    55.. contents:: 
  • NEMO/trunk/doc/rst/source/NEMO_guide.rst

    r10279 r10460  
    4141 
    4242   zooms 
    43    coarsening 
    4443   coupling 
    4544   assimilation 
     
    5655.. Next headings markup acording to readme.rst 
    5756 
    58 How to cite NEMO 
    59 ================ 
     57Reference publications 
     58====================== 
    6059 
    6160.. bibliography:: references.bib 
  • NEMO/trunk/doc/rst/source/conf.py

    r10279 r10460  
    6363# directories to ignore when looking for source files. 
    6464# This pattern also affects html_static_path and html_extra_path . 
    65 exclude_patterns = ['global.rst'] 
     65exclude_patterns = ['global.rst', 'coarsening.rst'] 
    6666 
    6767# The name of the Pygments (syntax highlighting) style to use. 
  • NEMO/trunk/doc/rst/source/coupling.rst

    r10279 r10460  
    1 ********************** 
    2 Coupling (OASIS & SAS) 
    3 ********************** 
     1******** 
     2Coupling 
     3******** 
    44 
    55NEMO currently exploits OASIS-3-MCT to implement a generalised coupled interface 
  • NEMO/trunk/doc/rst/source/data_assimilation.rst

    r10455 r10460  
    1 ************************************** 
    2 Data assimilation (OBS/SAO, ASM & TAM) 
    3 ************************************** 
     1***************** 
     2Data assimilation 
     3***************** 
    44 
    55.. contents:: 
  • NEMO/trunk/src/TOP/README.rst

    r10279 r10460  
    1 ********************* 
    2 Oceanic tracers (TOP) 
    3 ********************* 
     1*************** 
     2Oceanic tracers 
     3*************** 
    44 
    55.. contents:: 
Note: See TracChangeset for help on using the changeset viewer.