Changeset 11734


Ignore:
Timestamp:
2019-10-18T18:46:26+02:00 (11 months ago)
Author:
nicolasmartin
Message:

Review README for reference confgiurations

Location:
NEMO/trunk
Files:
19 edited

Legend:

Unmodified
Added
Removed
  • NEMO/trunk/CONTRIBUTING.rst

    r10594 r11734  
    33************ 
    44 
     5.. todo:: 
     6 
     7 
     8 
    59.. contents:: 
    6    :local: 
     10   :local: 
    711 
    812Sending feedbacks 
     
    1721- You have a question: create a topic in the appropriate :forge:`discussion <forum>` 
    1822- You would like to raise and issue: open a new ticket of the right type depending of its severity 
    19    
     23 
    2024  - "Unavoidable" :forge:`newticket?type=Bug       <bug>` 
    21      
     25 
    2226  - "Workable"    :forge:`newticket?type=Defect <defect>` 
    2327 
     
    2731=============== 
    2832 
    29 You have build a development relevant for NEMO shared reference: an addition of the source code,   
     33You have build a development relevant for NEMO shared reference: an addition of the source code, 
    3034a full fork of the reference, ... 
    3135 
     
    3438 
    3539The proposals for developments to be included in the shared NEMO reference are first examined by NEMO Developers 
    36 Committee / Scientific Advisory Board.  
     40Committee / Scientific Advisory Board. 
    3741The implementation of a new development requires some additionnal work from the intial developer. 
    3842These tasks will need to be scheduled with NEMO System Team. 
     
    4246---- 
    4347 
    44 You only would like to inform NEMO community about your developments.  
     48You only would like to inform NEMO community about your developments. 
    4549You can promote your work on NEMO forum gathering  the contributions fromof the community by creating 
    46 a specific topic here :forge:`discussion/forum/5 <dedicated forum>`  
     50a specific topic here :forge:`discussion/forum/5 <dedicated forum>` 
    4751 
    4852 
     
    5559  routines to the ticket, to highlight the proposed changes by adding to the ticket the output of ``svn diff`` 
    5660  or ``svn patch`` from your working copy. 
    57    
     61 
    5862| Your development seems relevant for addition into the future release of NEMO shared reference. 
    5963  Implementing it into NEMO shared reference following the usual quality control will require some additionnal work 
     
    6165  your suggestion should be send as a proposed enhancement here :forge:`newticket?type=Enhancement <enhancement>` 
    6266  including description of the development, its implementation, and the existing validations. 
    63    
    64   The proposed enhancement will be examined  by NEMO Developers Committee / Scientific Advisory Board.  
     67 
     68  The proposed enhancement will be examined  by NEMO Developers Committee / Scientific Advisory Board. 
    6569  Once approved by the  Committee, the assicated development task can be scheduled in NEMO development work plan, 
    6670  and tasks distributed between you as initial developer and PI of this development action, and the NEMO System Team. 
    67    
     71 
    6872  Once sucessful (meeting the usual quality control steps) this action will allow the merge of these developments with 
    6973  other developments of the year, building the future NEMO. 
  • NEMO/trunk/INSTALL.rst

    r11723 r11734  
    22Build the framework 
    33******************* 
     4 
     5.. todo:: 
     6 
     7 
    48 
    59.. contents:: 
     
    123127------------------------------------------------ 
    124128 
    125 +-----------+----------------------------------------+ 
    126 | ``arch``  | Compilation settings                   | 
    127 +-----------+----------------------------------------+ 
    128 | ``cfgs``  | :doc:`Reference configurations <cfgs>` | 
    129 +-----------+----------------------------------------+ 
    130 | ``doc``   | :doc:`Documentation <doc>`             | 
    131 +-----------+----------------------------------------+ 
    132 | ``ext``   | Dependencies included                  | 
    133 |           | (``AGRIF``, ``FCM`` & ``IOIPSL``)      | 
    134 +-----------+----------------------------------------+ 
    135 | ``mk``    | Compilation scripts                    | 
    136 +-----------+----------------------------------------+ 
    137 | ``src``   | :doc:`Modelling routines <src>`        | 
    138 +-----------+----------------------------------------+ 
    139 | ``tests`` | :doc:`Test cases <tests>`              | 
    140 |           | (unsupported)                          | 
    141 +-----------+----------------------------------------+ 
    142 | ``tools`` | :doc:`Utilities <tools>`               | 
    143 |           | to {pre,post}process data              | 
    144 +-----------+----------------------------------------+ 
     129+---------------+----------------------------------------+ 
     130| :file:`arch`  | Compilation settings                   | 
     131+---------------+----------------------------------------+ 
     132| :file:`cfgs`  | :doc:`Reference configurations <cfgs>` | 
     133+---------------+----------------------------------------+ 
     134| :file:`doc`   | :doc:`Documentation <doc>`             | 
     135+---------------+----------------------------------------+ 
     136| :file:`ext`   | Dependencies included                  | 
     137|               | (``AGRIF``, ``FCM`` & ``IOIPSL``)      | 
     138+---------------+----------------------------------------+ 
     139| :file:`mk`    | Compilation scripts                    | 
     140+---------------+----------------------------------------+ 
     141| :file:`src`   | :doc:`Modelling routines <src>`        | 
     142+---------------+----------------------------------------+ 
     143| :file:`tests` | :doc:`Test cases <tests>`              | 
     144|               | (unsupported)                          | 
     145+---------------+----------------------------------------+ 
     146| :file:`tools` | :doc:`Utilities <tools>`               | 
     147|               | to {pre,post}process data              | 
     148+---------------+----------------------------------------+ 
    145149 
    146150Setup your architecture configuration file 
     
    166170====================================== 
    167171 
    168 The main script to {re}compile and create executable is called ``makenemo`` located at 
     172The main script to {re}compile and create executable is called :file:`makenemo` located at 
    169173the root of the working copy. 
    170174It is used to identify the routines you need from the source code, to build the makefile and run it. 
     
    192196+------------+----------------------------------------------------------------------------+ 
    193197 
    194 After successful execution of ``makenemo`` command, 
     198After successful execution of :file:`makenemo` command, 
    195199the executable called `nemo` is available in the :file:`EXP00` directory 
    196200 
    197 More ``makenemo`` options 
    198 ------------------------- 
     201More :file:`makenemo` options 
     202----------------------------- 
    199203 
    200204``makenemo`` has several other options that can control which source files are selected and 
     
    229233----------------------------- 
    230234 
    231 * ``functions.sh`` : bash functions used by ``makenemo``, for instance to create the WORK directory 
    232 * ``cfg.txt`` : text list of configurations and source directories 
    233 * ``bld.cfg`` : FCM rules to compile 
     235* :file:`functions.sh`: bash functions used by ``makenemo``, for instance to create the WORK directory 
     236* :file:`cfg.txt`    : text list of configurations and source directories 
     237* :file:`bld.cfg`     : FCM rules for compilation 
    234238 
    235239Examples 
     
    243247================= 
    244248 
    245 Once ``makenemo`` has run successfully, 
    246 the ``nemo`` executable is available in ``./cfgs/MY_CONFIG/EXP00``. 
    247 For the reference configurations, the ``EXP00`` folder also contains the initial input files 
     249Once :file:`makenemo` has run successfully, 
     250the ``nemo`` executable is available in :file:`./cfgs/MY_CONFIG/EXP00`. 
     251For the reference configurations, the :file:`EXP00` folder also contains the initial input files 
    248252(namelists, ``*.xml`` files for the IOs, ...). 
    249253If the configuration needs other input files, they have to be placed here. 
     
    261265the list of active CPP keys can be found in :file:`./cfgs/'MYCONFIG'/cpp_MY_CONFIG.fcm` 
    262266 
    263 This text file can be edited by hand or with ``makenemo`` to change the list of active CPP keys. 
     267This text file can be edited by hand or with :file:`makenemo` to change the list of active CPP keys. 
    264268Once changed, one needs to recompile ``nemo`` in order for this change to be taken in account. 
    265269Note that most NEMO configurations will need to specify the following CPP keys: 
  • NEMO/trunk/README.rst

    r11723 r11734  
     1.. todo:: 
     2 
     3 
     4 
    15NEMO_ for *Nucleus for European Modelling of the Ocean* is a state-of-the-art modelling framework for 
    26research activities and forecasting services in ocean and climate sciences, 
     
    5660 Component    Reference Manual   Quick Start Guide 
    5761============ ================== =================== 
    58  |NEMO-OCE|   |DOI man OCE|_     |DOI strt gui| 
     62 |NEMO-OCE|   |DOI man OCE|_     |DOI qsg| 
    5963 |NEMO-ICE|   |DOI man ICE| 
    6064 |NEMO-MBG|   |DOI man MBG| 
  • NEMO/trunk/cfgs/AGRIF_DEMO/README.rst

    r11723 r11734  
    22Embedded zooms 
    33************** 
     4 
     5.. todo:: 
     6 
     7 
    48 
    59.. contents:: 
  • NEMO/trunk/cfgs/README.rst

    r11723 r11734  
    33************************ 
    44 
     5.. todo:: 
     6 
     7   Lack of illustrations for ref. cfgs, and more generally in the guide. 
     8 
    59NEMO is distributed with a set of reference configurations allowing both 
    610the user to set up his own first applications and 
    711the developer to test/validate his NEMO developments (using SETTE package). 
    812 
     13.. contents:: 
     14   :local: 
     15   :depth: 1 
     16 
    917.. attention:: 
    1018 
     
    2129=========================================================== 
    2230 
    23 A user who wants to compile the ORCA2_ICE_PISCES_ reference configuration using ``makenemo`` 
    24 should use the following, by selecting among available architecture file or providing a user defined one: 
     31To compile the ORCA2_ICE_PISCES_ reference configuration using ``makenemo``, 
     32one should use the following, by selecting among available architecture file or 
     33providing a user defined one: 
    2534 
    2635.. code-block:: console 
    2736 
    28    $ ./makenemo -r 'ORCA2_ICE_PISCES' -m 'my-fortran.fcm' -j '4' 
     37   $ ./makenemo -r 'ORCA2_ICE_PISCES' -m 'my_arch' -j '4' 
    2938 
    3039A new ``EXP00`` folder will be created within the selected reference configurations, 
    31 namely ``./cfgs/ORCA2_ICE_PISCES/EXP00``, 
    32 where it will be necessary to uncompress the Input & Forcing Files listed in the above table. 
     40namely ``./cfgs/ORCA2_ICE_PISCES/EXP00``. 
     41It will be necessary to uncompress the archives listed in the above table for 
     42the given reference configuration that includes input & forcing files. 
    3343 
    3444Then it will be possible to launch the execution of the model through a runscript 
     
    3848====================== 
    3949 
    40 All forcing files listed below in the table are available from |NEMO archives URL|_ 
    41  
    42 .. |NEMO archives URL| image:: https://www.zenodo.org/badge/DOI/10.5281/zenodo.1472245.svg 
    43 .. _NEMO archives URL: https://doi.org/10.5281/zenodo.1472245 
    44  
    45 ====================== ===== ===== ===== ======== ======= ================================================ 
    46  Configuration                     Component(s)                            Input & Forcing File(s) 
    47 ---------------------- ---------------------------------- ------------------------------------------------ 
    48  Name                   OCE   SI3   TOP   PISCES   AGRIF 
    49 ====================== ===== ===== ===== ======== ======= ================================================ 
    50  AGRIF_DEMO_             X     X                     X     AGRIF_DEMO_v4.0.tar, ORCA2_ICE_v4.0.tar 
    51  AMM12_                  X                                 AMM12_v4.0.tar 
    52  C1D_PAPA_               X                                 INPUTS_C1D_PAPA_v4.0.tar 
    53  GYRE_BFM_               X           X                     *none* 
    54  GYRE_PISCES_            X           X      X              *none* 
    55  ORCA2_ICE_PISCES_       X     X     X      X              ORCA2_ICE_v4.0.tar, INPUTS_PISCES_v4.0.tar 
    56  ORCA2_OFF_PISCES_                   X      X              ORCA2_OFF_v4.0.tar, INPUTS_PISCES_v4.0.tar 
    57  ORCA2_OFF_TRC_                      X                     ORCA2_OFF_v4.0.tar 
    58  ORCA2_SAS_ICE_                X                           ORCA2_ICE_v4.0.tar, INPUTS_SAS_v4.0.tar 
    59  SPITZ12_                X     X                           SPITZ12_v4.0.tar 
    60 ====================== ===== ===== ===== ======== ======= ================================================ 
     50All forcing files listed below in the table are available from |DOI data|_ 
     51 
     52=================== === === === === === ================================== 
     53 Configuration       Component(s)        Archives (input & forcing files) 
     54------------------- ------------------- ---------------------------------- 
     55 Name                O   S   T   P   A 
     56=================== === === === === === ================================== 
     57 AGRIF_DEMO_         X   X           X   AGRIF_DEMO_v4.0.tar, 
     58                                         ORCA2_ICE_v4.0.tar 
     59 AMM12_              X                   AMM12_v4.0.tar 
     60 C1D_PAPA_           X                   INPUTS_C1D_PAPA_v4.0.tar 
     61 GYRE_BFM_           X       X           *none* 
     62 GYRE_PISCES_        X       X   X       *none* 
     63 ORCA2_ICE_PISCES_   X   X   X   X       ORCA2_ICE_v4.0.tar, 
     64                                         INPUTS_PISCES_v4.0.tar 
     65 ORCA2_OFF_PISCES_           X   X       ORCA2_OFF_v4.0.tar, 
     66                                         INPUTS_PISCES_v4.0.tar 
     67 ORCA2_OFF_TRC_              X           ORCA2_OFF_v4.0.tar 
     68 ORCA2_SAS_ICE_          X               ORCA2_ICE_v4.0.tar, 
     69                                         INPUTS_SAS_v4.0.tar 
     70 SPITZ12_            X   X               SPITZ12_v4.0.tar 
     71=================== === === === === === ================================== 
     72 
     73.. admonition:: Legend for component combination 
     74 
     75   O for OCE, S for SI\ :sup:`3`, T for TOP, P for PISCES and A for AGRIF 
    6176 
    6277AGRIF_DEMO 
     
    7287particular interest to test sea ice coupling. 
    7388 
     89.. image:: _static/AGRIF_DEMO_no_cap.jpg 
     90   :scale: 66% 
     91   :align: center 
     92 
    7493The 1:1 grid can be used alone as a benchmark to check that 
    7594the model solution is not corrupted by grid exchanges. 
    7695Note that since grids interact only at the baroclinic time level, 
    7796numerically exact results can not be achieved in the 1:1 case. 
    78 Perfect reproducibility is obtained only by switching to a fully explicit setup instead of a split explicit free surface scheme. 
     97Perfect reproducibility is obtained only by switching to a fully explicit setup instead of 
     98a split explicit free surface scheme. 
    7999 
    80100AMM12 
     
    84104a regional configuration covering the Northwest European Shelf domain on 
    85105a regular horizontal grid of ~12 km of resolution (see :cite:`ODEA2012`). 
     106 
     107.. image:: _static/AMM_domain.png 
     108   :align: center 
    86109 
    87110This configuration allows to tests several features of NEMO specifically addressed to the shelf seas. 
     
    99122-------- 
    100123 
    101 ``C1D_PAPA`` is a 1D configuration for the `PAPA station <http://www.pmel.noaa.gov/OCS/Papa/index-Papa.shtml>`_ located in the northern-eastern Pacific Ocean at 50.1°N, 144.9°W. 
    102 See `Reffray et al. (2015) <http://www.geosci-model-dev.net/8/69/2015>`_ for the description of its physical and numerical turbulent-mixing behaviour. 
    103  
    104 The water column setup, called NEMO1D, is activated with the inclusion of the CPP key ``key_c1d`` and 
    105 has a horizontal domain of 3x3 grid points. 
    106  
    107 This reference configuration uses 75 vertical levels grid (1m at the surface), GLS turbulence scheme with K-epsilon closure and the NCAR bulk formulae. 
     124.. figure:: _static/Papa2015.jpg 
     125   :height: 225px 
     126   :align:  left 
     127 
     128``C1D_PAPA`` is a 1D configuration for the `PAPA station`_ located in 
     129the northern-eastern Pacific Ocean at 50.1°N, 144.9°W. 
     130See :gmd:`Reffray et al. (2015) <8/69/2015>` for the description of 
     131its physical and numerical turbulent-mixing behaviour. 
     132 
     133| The water column setup, called NEMO1D, is activated with 
     134  the inclusion of the CPP key ``key_c1d`` and 
     135  has a horizontal domain of 3x3 grid points. 
     136| This reference configuration uses 75 vertical levels grid (1m at the surface), 
     137  GLS turbulence scheme with K-epsilon closure and the NCAR bulk formulae. 
     138 
    108139Data provided with ``INPUTS_C1D_PAPA_v4.0.tar`` file account for: 
    109140 
    110 - ``forcing_PAPASTATION_1h_y201[0-1].nc`` : ECMWF operational analysis atmospheric forcing rescaled to 1h (with long and short waves flux correction) for years 2010 and 2011 
    111 - ``init_PAPASTATION_m06d15.nc`` : Initial Conditions from observed data and Levitus 2009 climatology 
    112 - ``chlorophyll_PAPASTATION.nc`` : surface chlorophyll file from Seawifs data 
     141- :file:`forcing_PAPASTATION_1h_y201[0-1].nc`: 
     142  ECMWF operational analysis atmospheric forcing rescaled to 1h 
     143  (with long and short waves flux correction) for years 2010 and 2011 
     144- :file:`init_PAPASTATION_m06d15.nc`: Initial Conditions from 
     145  observed data and Levitus 2009 climatology 
     146- :file:`chlorophyll_PAPASTATION.nc`: surface chlorophyll file from Seawifs data 
    113147 
    114148GYRE_BFM 
    115149-------- 
    116150 
    117 ``GYRE_BFM`` shares the same physical setup of GYRE_PISCES_, but NEMO is coupled with the `BFM <http://www.bfm-community.eu/>`_ biogeochemical model as described in ``./cfgs/GYRE_BFM/README``. 
     151``GYRE_BFM`` shares the same physical setup of GYRE_PISCES_, 
     152but NEMO is coupled with the `BFM`_ biogeochemical model as described in ``./cfgs/GYRE_BFM/README``. 
    118153 
    119154GYRE_PISCES 
     
    125160Analytical forcing for heat, freshwater and wind-stress fields are applied. 
    126161 
    127 This configuration acts also as demonstrator of the **user defined setup** (``ln_read_cfg = .false.``) and 
    128 grid setting are handled through the ``&namusr_def`` controls in ``namelist_cfg``: 
     162This configuration acts also as demonstrator of the **user defined setup** 
     163(``ln_read_cfg = .false.``) and grid setting are handled through 
     164the ``&namusr_def`` controls in :file:`namelist_cfg`: 
    129165 
    130166.. literalinclude:: ../../../cfgs/GYRE_PISCES/EXPREF/namelist_cfg 
    131167   :language: fortran 
    132    :lines: 34-42 
     168   :lines:    35-41 
    133169 
    134170Note that, the default grid size is 30x20 grid points (with ``nn_GYRE = 1``) and 
    135171vertical levels are set by ``jpkglo``. 
    136 The specific code changes can be inspected in ``./src/OCE/USR``. 
    137  
    138 **Running GYRE as a benchmark** : 
    139 this simple configuration can be used as a benchmark since it is easy to increase resolution, 
    140 with the drawback of getting results that have a very limited physical meaning. 
    141  
    142 GYRE grid resolution can be increased at runtime by setting a different value of ``nn_GYRE`` (integer multiplier scaling factor), as described in the following table: 
    143  
    144 =========== ========= ========== ============ =================== 
    145 ``nn_GYRE``  *jpiglo*  *jpjglo*   ``jpkglo``   **Equivalent to** 
    146 =========== ========= ========== ============ =================== 
    147  1           30        20         31           GYRE 1° 
    148  25          750       500        101          ORCA 1/2° 
    149  50          1500      1000       101          ORCA 1/4° 
    150  150         4500      3000       101          ORCA 1/12° 
    151  200         6000      4000       101          ORCA 1/16° 
    152 =========== ========= ========== ============ =================== 
    153  
    154 Note that, it is necessary to set ``ln_bench = .true.`` in ``namusr_def`` to 
    155 avoid problems in the physics computation and that 
    156 the model timestep should be adequately rescaled. 
    157  
    158 For example if ``nn_GYRE = 150``, equivalent to an ORCA 1/12° grid, 
    159 the timestep ``rn_rdt = 1200`` should be set to 1200 seconds 
    160  
    161 Differently from previous versions of NEMO, 
    162 the code uses by default the time-splitting scheme and 
    163 internally computes the number of sub-steps. 
     172The specific code changes can be inspected in :file:`./src/OCE/USR`. 
     173 
     174.. rubric:: Running GYRE as a benchmark 
     175 
     176| This simple configuration can be used as a benchmark since it is easy to increase resolution, 
     177  with the drawback of getting results that have a very limited physical meaning. 
     178| GYRE grid resolution can be increased at runtime by setting a different value of ``nn_GYRE`` 
     179  (integer multiplier scaling factor), as described in the following table: 
     180 
     181=========== ============ ============ ============ =============== 
     182``nn_GYRE``  ``jpiglo``   ``jpjglo``   ``jpkglo``   Equivalent to 
     183=========== ============ ============ ============ =============== 
     184 1           30           20           31           GYRE 1° 
     185 25          750          500          101          ORCA 1/2° 
     186 50          1500         1000         101          ORCA 1/4° 
     187 150         4500         3000         101          ORCA 1/12° 
     188 200         6000         4000         101          ORCA 1/16° 
     189=========== ============ ============ ============ =============== 
     190 
     191| Note that, it is necessary to set ``ln_bench = .true.`` in ``&namusr_def`` to 
     192  avoid problems in the physics computation and that 
     193  the model timestep should be adequately rescaled. 
     194| For example if ``nn_GYRE = 150``, equivalent to an ORCA 1/12° grid, 
     195  the timestep ``rn_rdt`` should be set to 1200 seconds 
     196  Differently from previous versions of NEMO, the code uses by default the time-splitting scheme and 
     197  internally computes the number of sub-steps. 
    164198 
    165199ORCA2_ICE_PISCES 
     
    174208the ratio of anisotropy is nearly one everywhere 
    175209 
    176 this configuration uses the three components 
    177  
    178 - |NEMO-OCE|, the ocean dynamical core 
    179 - |NEMO-ICE|, the thermodynamic-dynamic sea ice model. 
    180 - |NEMO-MBG|, passive tracer transport module and PISCES BGC model :cite:`gmd-8-2465-2015` 
     210This configuration uses the three components 
     211 
     212- |OCE|, the ocean dynamical core 
     213- |ICE|, the thermodynamic-dynamic sea ice model. 
     214- |MBG|, passive tracer transport module and PISCES BGC model :cite:`gmd-8-2465-2015` 
    181215 
    182216All components share the same grid. 
    183  
    184217The model is forced with CORE-II normal year atmospheric forcing and 
    185218it uses the NCAR bulk formulae. 
    186219 
    187 In this ``ORCA2_ICE_PISCES`` configuration, 
    188 AGRIF nesting can be activated that includes a nested grid in the Agulhas region. 
    189  
    190 To set up this configuration, after extracting NEMO: 
    191  
    192 Build your AGRIF configuration directory from ``ORCA2_ICE_PISCES``, 
    193 with the ``key_agrif`` CPP key activated: 
    194  
    195 .. code-block:: console 
    196  
    197         $ ./makenemo -r 'ORCA2_ICE_PISCES' -n 'AGRIF' add_key 'key_agrif' 
    198  
    199 By using the input files and namelists for ``ORCA2_ICE_PISCES``, 
    200 the AGRIF test configuration is ready to run. 
    201  
    202 **Ocean Physics** 
    203  
    204 - *horizontal diffusion on momentum*: the eddy viscosity coefficient depends on the geographical position. It is taken as 40000 m^2/s, reduced in the equator regions (2000 m^2/s) excepted near the western boundaries. 
    205 - *isopycnal diffusion on tracers*: the diffusion acts along the isopycnal surfaces (neutral surface) with an eddy diffusivity coefficient of 2000 m^2/s. 
    206 - *Eddy induced velocity parametrization* with a coefficient that depends on the growth rate of baroclinic instabilities (it usually varies from 15 m^2/s to 3000 m^2/s). 
    207 - *lateral boundary conditions* : zero fluxes of heat and salt and no-slip conditions are applied through lateral solid boundaries. 
    208 - *bottom boundary condition* : zero fluxes of heat and salt are applied through the ocean bottom. 
    209   The Beckmann [19XX] simple bottom boundary layer parameterization is applied along continental slopes. 
    210   A linear friction is applied on momentum. 
    211 - *convection*: the vertical eddy viscosity and diffusivity coefficients are increased to 1 m^2/s in case of static instability. 
    212 - *time step* is 5760sec (1h36') so that there is 15 time steps in one day. 
     220.. rubric:: Ocean Physics 
     221 
     222:horizontal diffusion on momentum: 
     223   the eddy viscosity coefficient depends on the geographical position. 
     224   It is taken as 40000 m\ :sup:`2`/s, reduced in the equator regions (2000 m\ :sup:`2`/s) 
     225   excepted near the western boundaries. 
     226:isopycnal diffusion on tracers: 
     227   the diffusion acts along the isopycnal surfaces (neutral surface) with 
     228   an eddy diffusivity coefficient of 2000 m\ :sup:`2`/s. 
     229:Eddy induced velocity parametrization: 
     230   With a coefficient that depends on the growth rate of baroclinic instabilities 
     231   (it usually varies from 15 m\ :sup:`2`/s to 3000 m\ :sup:`2`/s). 
     232:lateral boundary conditions: 
     233   Zero fluxes of heat and salt and no-slip conditions are applied through lateral solid boundaries. 
     234:bottom boundary condition: 
     235   Zero fluxes of heat and salt are applied through the ocean bottom. 
     236   The Beckmann [19XX] simple bottom boundary layer parameterization is applied along 
     237   continental slopes. 
     238   A linear friction is applied on momentum. 
     239:convection: 
     240   The vertical eddy viscosity and diffusivity coefficients are increased to 1 m\ :sup:`2`/s in 
     241   case of static instability. 
     242:time step: is 5760sec (1h36') so that there is 15 time steps in one day. 
    213243 
    214244ORCA2_OFF_PISCES 
     
    218248but only PISCES model is an active component of TOP. 
    219249 
    220  
    221250ORCA2_OFF_TRC 
    222251------------- 
    223252 
    224 ``ORCA2_OFF_TRC`` is based on the ORCA2 global ocean configuration 
    225 (see ORCA2_ICE_PISCES_ for general description) along with the tracer passive transport module (TOP), but dynamical fields are pre-calculated and read with specific time frequency. 
    226  
    227 This enables for an offline coupling of TOP components, 
    228 here specifically inorganic carbon compounds (cfc11, cfc12, sf6, c14) and water age module (age). 
    229 See ``namelist_top_cfg`` to inspect the selection of each component with the dedicated logical keys. 
     253| ``ORCA2_OFF_TRC`` is based on the ORCA2 global ocean configuration 
     254  (see ORCA2_ICE_PISCES_ for general description) along with 
     255  the tracer passive transport module (TOP), 
     256  but dynamical fields are pre-calculated and read with specific time frequency. 
     257| This enables for an offline coupling of TOP components, 
     258  here specifically inorganic carbon compounds (CFC11, CFC12, SF6, C14) and water age module (age). 
     259  See :file:`namelist_top_cfg` to inspect the selection of 
     260  each component with the dedicated logical keys. 
    230261 
    231262Pre-calculated dynamical fields are provided to NEMO using 
    232 the namelist ``&namdta_dyn``  in ``namelist_cfg``, 
     263the namelist ``&namdta_dyn``  in :file:`namelist_cfg`, 
    233264in this case with a 5 days frequency (120 hours): 
    234265 
    235 .. literalinclude:: ../../../cfgs/GYRE_PISCES/EXPREF/namelist_ref 
     266.. literalinclude:: ../../namelists/namdta_dyn 
    236267   :language: fortran 
    237    :lines: 935-960 
    238  
    239 Input dynamical fields for this configuration (``ORCA2_OFF_v4.0.tar``) comes from 
     268 
     269Input dynamical fields for this configuration (:file:`ORCA2_OFF_v4.0.tar`) comes from 
    240270a 2000 years long climatological simulation of ORCA2_ICE using ERA40 atmospheric forcing. 
    241271 
    242 Note that, this configuration default uses linear free surface (``ln_linssh = .true.``) assuming that 
    243 model mesh is not varying in time and 
    244 it includes the bottom boundary layer parameterization (``ln_trabbl = .true.``) that 
    245 requires the provision of bbl coefficients through ``sn_ubl`` and ``sn_vbl`` fields. 
    246  
    247 It is also possible to activate PISCES model (see ``ORCA2_OFF_PISCES``) or 
    248 a user defined set of tracers and source-sink terms with ``ln_my_trc = .true.`` 
    249 (and adaptation of ``./src/TOP/MY_TRC`` routines). 
     272| Note that, 
     273  this configuration default uses linear free surface (``ln_linssh = .true.``) assuming that 
     274  model mesh is not varying in time and 
     275  it includes the bottom boundary layer parameterization (``ln_trabbl = .true.``) that 
     276  requires the provision of BBL coefficients through ``sn_ubl`` and ``sn_vbl`` fields. 
     277| It is also possible to activate PISCES model (see ``ORCA2_OFF_PISCES``) or 
     278  a user defined set of tracers and source-sink terms with ``ln_my_trc = .true.`` 
     279  (and adaptation of ``./src/TOP/MY_TRC`` routines). 
    250280 
    251281In addition, the offline module (OFF) allows for the provision of further fields: 
     
    254284   by including an input datastream similarly to the following: 
    255285 
    256 .. code-block:: fortran 
    257  
    258    sn_rnf  = 'dyna_grid_T', 120, 'sorunoff' , .true., .true., 'yearly', '', '', '' 
    259  
    260 2. **VVL dynamical fields**, 
    261    in the case input data were produced by a dyamical core using variable volume (``ln_linssh = .false.``) 
    262    it necessary to provide also diverce and E-P at before timestep by 
     286   .. code-block:: fortran 
     287 
     288      sn_rnf  = 'dyna_grid_T', 120, 'sorunoff' , .true., .true., 'yearly', '', '', '' 
     289 
     2902. **VVL dynamical fields**, in the case input data were produced by a dyamical core using 
     291   variable volume (``ln_linssh = .false.``) 
     292   it is necessary to provide also diverce and E-P at before timestep by 
    263293   including input datastreams similarly to the following 
    264294 
    265 .. code-block:: fortran 
    266  
    267    sn_div  = 'dyna_grid_T', 120, 'e3t'      , .true., .true., 'yearly', '', '', '' 
    268    sn_empb = 'dyna_grid_T', 120, 'sowaflupb', .true., .true., 'yearly', '', '', '' 
    269  
     295   .. code-block:: fortran 
     296 
     297      sn_div  = 'dyna_grid_T', 120, 'e3t'      , .true., .true., 'yearly', '', '', '' 
     298      sn_empb = 'dyna_grid_T', 120, 'sowaflupb', .true., .true., 'yearly', '', '', '' 
    270299 
    271300More details can be found by inspecting the offline data manager in 
    272 the routine ``./src/OFF/dtadyn.F90``. 
     301the routine :file:`./src/OFF/dtadyn.F90`. 
    273302 
    274303ORCA2_SAS_ICE 
    275304------------- 
    276305 
    277 ORCA2_SAS_ICE is a demonstrator of the Stand-Alone Surface (SAS) module and 
    278 it relies on ORCA2 global ocean configuration (see ORCA2_ICE_PISCES_ for general description). 
    279  
    280 The standalone surface module allows surface elements such as sea-ice, iceberg drift, and 
    281 surface fluxes to be run using prescribed model state fields. 
    282 It can profitably be used to compare different bulk formulae or 
    283 adjust the parameters of a given bulk formula. 
    284  
    285 More informations about SAS can be found in NEMO manual. 
     306| ORCA2_SAS_ICE is a demonstrator of the Stand-Alone Surface (SAS) module and 
     307  it relies on ORCA2 global ocean configuration (see ORCA2_ICE_PISCES_ for general description). 
     308| The standalone surface module allows surface elements such as sea-ice, iceberg drift, and 
     309  surface fluxes to be run using prescribed model state fields. 
     310  It can profitably be used to compare different bulk formulae or 
     311  adjust the parameters of a given bulk formula. 
     312 
     313More informations about SAS can be found in :doc:`NEMO manual <cite>`. 
    286314 
    287315SPITZ12 
     
    290318``SPITZ12`` is a regional configuration around the Svalbard archipelago 
    291319at 1/12° of horizontal resolution and 75 vertical levels. 
    292 See `Rousset et al. (2015) <https://www.geosci-model-dev.net/8/2991/2015/>`_ for more details. 
     320See :gmd:`Rousset et al. (2015) <8/2991/2015>` for more details. 
    293321 
    294322This configuration references to year 2002, 
  • NEMO/trunk/cfgs/SHARED/README.rst

    r10598 r11734  
    33*********** 
    44 
     5.. todo:: 
     6 
     7 
     8 
    59.. contents:: 
    6            :local: 
     10   :local: 
    711 
    812Output of diagnostics in NEMO is usually done using XIOS. 
     
    1115Much more information is available from the XIOS homepage above and from the NEMO manual. 
    1216 
    13 Use of XIOS for diagnostics is activated using the pre-compiler key ``key_iomput``.  
     17Use of XIOS for diagnostics is activated using the pre-compiler key ``key_iomput``. 
    1418 
    1519Extracting and installing XIOS 
     
    1923   If you want to use single file output you will need to compile the HDF & NetCDF libraries to allow parallel IO. 
    20242. Download the version of XIOS that you wish to use. The recommended version is now XIOS 2.5: 
    21     
     25 
    2226.. code-block:: console 
    2327 
     
    2529 
    2630and follow the instructions in `XIOS documentation <http://forge.ipsl.jussieu.fr/ioserver/wiki/documentation>`_ to compile it. 
    27    If you find problems at this stage, support can be found by subscribing to the `XIOS mailing list <http://forge.ipsl.jussieu.fr/mailman/listinfo.cgi/xios-users>`_ and sending a mail message to it.  
     31   If you find problems at this stage, support can be found by subscribing to the `XIOS mailing list <http://forge.ipsl.jussieu.fr/mailman/listinfo.cgi/xios-users>`_ and sending a mail message to it. 
    2832 
    2933XIOS Configuration files 
     
    73771. Add any necessary code to calculate you new diagnostic in NEMO 
    74782. Send the field to XIOS using ``CALL iom_put( 'field_id', variable )`` where ``field_id`` is a unique id for your new diagnostics and variable is the fortran variable containing the data. 
    75    This should be called at every model timestep regardless of how often you want to output the field. No time averaging should be done in the model code.  
     79   This should be called at every model timestep regardless of how often you want to output the field. No time averaging should be done in the model code. 
    76803. If it is computationally expensive to calculate your new diagnostic you should also use "iom_use" to determine if it is requested in the current model run. For example, 
    77     
     81 
    7882.. code-block:: fortran 
    7983 
  • NEMO/trunk/doc/rst/source/acro.rst

    r11718 r11734  
    22Acronyms 
    33******** 
     4 
     5.. todo:: 
     6 
     7 
    48 
    59.. glossary:: 
  • NEMO/trunk/doc/rst/source/cite.rst

    r11718 r11734  
    22How to cite 
    33*********** 
     4 
     5.. todo:: 
     6 
     7 
    48 
    59|NEMO-OCE| 
  • NEMO/trunk/doc/rst/source/conf.py

    r11718 r11734  
    251251# Link aliases 
    252252extlinks = { 
    253    'doi'    : ('https://doi.org/%s'                       , 'doi:'), 
    254    'forge'  : ('https://forge.ipsl.jussieu.fr/nemo/%s'    ,   None), 
    255    'github' : ('https://github.com/%s'                    ,   None), 
    256    'xios'   : ('https://forge.ipsl.jussieu.fr/ioserver/%s',   None), 
    257    'website': ('https://www.nemo-ocean.eu/%s'             ,   None), 
    258    'zenodo' : ('https://zenodo.org/publication/%s'        ,   None) 
     253   'doi'    : ('https://doi.org/%s'                                                    , 'doi:'), 
     254   'doxy'   : ('https://forge.ipsl.jussieu.fr/nemo/chrome/site/doc/NEMO/manual/html/%s',   None), 
     255   'forge'  : ('https://forge.ipsl.jussieu.fr/nemo/%s'                                 ,   None), 
     256   'gmd'    : ('https://www.geosci-model-dev.net/%s'                                   ,   None), 
     257   'github' : ('https://github.com/%s'                                                 ,   None), 
     258   'xios'   : ('https://forge.ipsl.jussieu.fr/ioserver/%s'                             ,   None), 
     259   'website': ('https://www.nemo-ocean.eu/%s'                                          ,   None), 
     260   'zenodo' : ('https://zenodo.org/publication/%s'                                     ,   None) 
    259261} 
    260262 
  • NEMO/trunk/doc/rst/source/cplg.rst

    r11718 r11734  
    33******** 
    44 
     5.. todo:: 
     6 
     7 
     8 
    59NEMO currently exploits OASIS-3-MCT (versions 1 to 4) to implement a generalised coupled interface 
    6 (`Coupled Formulation <http://forge.ipsl.jussieu.fr/nemo/doxygen/node50.html?doc=NEMO>`_). 
     10(:doxy:`Coupled Formulation <node50.html?doc=NEMO>`). 
    711It can be used to interface with most of the European atmospheric GCM (ARPEGE, ECHAM, ECMWF, Ha- dAM, HadGAM, LMDz), as well as to regional atmospheric models (WRF, COSMO, Meso-NH, AROME). 
    8 To implement the coupling of two independent NEMO components, ocean on one hand and sea-ice plus other surface processes on the other hand 
    9 (`Standalone Surface Module - SAS <http://forge.ipsl.jussieu.fr/nemo/doxygen/node46.html?doc=NEMO>`_). 
     12To implement the coupling of two independent NEMO components, 
     13ocean on one hand and sea-ice plus other surface processes on the other hand 
     14(:doxy:`Standalone Surface Module - SAS <node46.html?doc=NEMO>`). 
    1015 
    11 To enable the OASIS interface the required compilation key is ``key_oasis3``. You must also add ``key_oasis3_v1v2`` if you use OASIS-3-MCT version 1 and 2. 
    12 The parameters to set are in sections ``namsbc_cpl`` and in case of using of SAS also in section ``namsbc_sas``. 
     16To enable the OASIS interface the required compilation key is ``key_oasis3``. 
     17You must also add ``key_oasis3_v1v2`` if you use OASIS-3-MCT version 1 and 2. 
     18The parameters to set are in sections ``namsbc_cpl`` and 
     19in case of using of SAS also in section ``namsbc_sas``. 
  • NEMO/trunk/doc/rst/source/da.rst

    r11718 r11734  
    22Data assimilation 
    33***************** 
     4 
     5.. todo:: 
     6 
     7 
    48 
    59.. contents:: 
  • NEMO/trunk/doc/rst/source/doc.rst

    r11718 r11734  
    22Building the documentation 
    33************************** 
     4 
     5.. todo:: 
     6 
     7 
    48 
    59:file:`latex`    : LaTeX sources and Latexmk configuration to build reference manuals with :file:`manual_build.sh` 
  • NEMO/trunk/doc/rst/source/global.rst

    r11718 r11734  
    2828 
    2929.. _AGRIF:  http://agrif.imag.fr 
     30.. _BFM:    http://www.bfm-community.eu 
    3031.. _FCM:    https://metomi.github.io/fcm 
    3132.. _IOIPSL: https://forge.ipsl.jussieu.fr/igcmg/browser/IOIPSL 
     
    4041.. _BFM man: https://cmcc-foundation.github.io/www.bfm-community.eu/files/bfm-nemo-manual_r1.0_201508.pdf 
    4142.. _RST man: https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html 
     43.. _PAPA station: http://www.pmel.noaa.gov/OCS/Papa/index-Papa.shtml 
    4244 
    4345.. DOI 
     
    4547   .. Publications (`:samp:` to deactivate link for unpublished documents) 
    4648 
    47 .. _DOI man   OCE:        https://doi.org/10.5281/zenodo.1464816 
    48 .. _DOI man   ICE: :samp: https://doi.org/10.5281/zenodo.1471689 
    49 .. _DOI man   MBG: :samp: https://doi.org/10.5281/zenodo.1471700 
    50 .. _DOI strt  gui: :samp: https://doi.org/10.5281/zenodo.1475325 
     49.. _DOI man OCE:          https://doi.org/10.5281/zenodo.1464816 
     50.. _DOI man ICE:  :samp: https://doi.org/10.5281/zenodo.1471689 
     51.. _DOI man MBG:  :samp: https://doi.org/10.5281/zenodo.1471700 
     52.. _DOI qsg:      :samp: https://doi.org/10.5281/zenodo.1475325 
    5153.. _DOI dev  stgy:        https://doi.org/10.5281/zenodo.1471663 
     54.. _DOI data:             https://doi.org/10.5281/zenodo.1472245 
    5255 
    5356   .. Badges (same labels as previously, substitution to link images) 
    5457 
    55 .. |DOI man   OCE| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.1464816.svg 
    56 .. |DOI man   ICE| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.1471689.svg 
    57 .. |DOI man   MBG| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.1471700.svg 
    58 .. |DOI strt  gui| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.1475325.svg 
     58.. |DOI man OCE| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.1464816.svg 
     59.. |DOI man ICE| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.1471689.svg 
     60.. |DOI man MBG| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.1471700.svg 
     61.. |DOI qsg|     image:: https://zenodo.org/badge/DOI/10.5281/zenodo.1475325.svg 
     62.. |DOI data|    image:: https://zenodo.org/badge/DOI/10.5281/zenodo.1472245.svg 
  • NEMO/trunk/doc/rst/source/guide.rst

    r11718 r11734  
    2828 
    2929   setup 
    30    dia 
     30   diags 
    3131   tools 
    3232 
  • NEMO/trunk/doc/rst/source/setup.rst

    r10552 r11734  
    22Setting up a new configuration 
    33****************************** 
     4 
     5.. todo:: 
     6 
     7 
    48 
    59.. contents:: 
     
    7579   makenemo –n 'MY_NEW_CONFIG' -r 'ORCA2_ICE_PISCES' 
    7680 
    77 where ``MY_NEW_CONFIG`` can be substituted with a suitably descriptive name for your new configuration.   
     81where ``MY_NEW_CONFIG`` can be substituted with a suitably descriptive name for your new configuration. 
    7882 
    7983The purpose of this step is simply to create and populate the appropriate ``WORK``, ``MY_SRC`` and 
     
    129133are often used as demonstrators or for process evaluation and comparison. 
    130134This method can be used whenever the domain geometry has a simple mathematical description and 
    131 the ocean initial state and boundary forcing is described analytically.  
     135the ocean initial state and boundary forcing is described analytically. 
    132136As a start, consider the case of starting a completely new ocean-only test case based on 
    133137the ``LOCK_EXCHANGE`` example. 
  • NEMO/trunk/doc/rst/source/src.rst

    r11718 r11734  
    1 ************************************* 
     1******* 
    22Sources 
    3 ************************************* 
     3******* 
     4 
     5.. todo:: 
     6 
     7 
    48 
    59:file:`ICE`: |NEMO-ICE| 
  • NEMO/trunk/src/OCE/CRS/README.rst

    r10279 r11734  
    22On line biogeochemistry coarsening 
    33********************************** 
     4 
     5.. todo:: 
     6 
     7 
    48 
    59.. contents:: 
     
    6367                              ! 1, MAX of KZ 
    6468                              ! 2, MIN of KZ 
    65                               ! 3, 10^(MEAN(LOG(KZ))  
    66                               ! 4, MEDIANE of KZ  
     69                              ! 3, 10^(MEAN(LOG(KZ)) 
     70                              ! 4, MEDIANE of KZ 
    6771      ln_crs_wn   = .false.   ! wn coarsened (T) or computed using horizontal divergence ( F ) 
    6872                              !                           ! 
     
    7377  the north-fold lateral boundary condition (ORCA025, ORCA12, ORCA36, ...). 
    7478- ``nn_msh_crs = 1`` will activate the generation of the coarsened grid meshmask. 
    75 - ``nn_crs_kz`` is the operator to coarsen the vertical mixing coefficient.  
     79- ``nn_crs_kz`` is the operator to coarsen the vertical mixing coefficient. 
    7680- ``ln_crs_wn`` 
    7781 
     
    8084  - when ``key_vvl`` is not activated, 
    8185 
    82     - coarsened vertical velocities are computed using horizontal divergence (``ln_crs_wn = .false.``)  
     86    - coarsened vertical velocities are computed using horizontal divergence (``ln_crs_wn = .false.``) 
    8387    - or coarsened vertical velocities are computed with an average operator (``ln_crs_wn = .true.``) 
    8488- ``ln_crs_top = .true.``: should be activated to run BCG model in coarsened space; 
     
    97101 
    98102In the [attachment:iodef.xml iodef.xml]  file, a "nemo" context is defined and 
    99 some variable defined in [attachment:file_def.xml file_def.xml] are writted on the ocean-dynamic grid.   
     103some variable defined in [attachment:file_def.xml file_def.xml] are writted on the ocean-dynamic grid. 
    100104To write variables on the coarsened grid, and in particular the passive tracers, 
    101105a "nemo_crs" context should be defined in [attachment:iodef.xml iodef.xml] and 
     
    111115  interpolated `on-the-fly <http://forge.ipsl.jussieu.fr/nemo/wiki/Users/SetupNewConfiguration/Weight-creator>`_. 
    112116  Example of namelist for PISCES : 
    113    
     117 
    114118   .. code-block:: fortran 
    115119 
     
    134138         rn_trfac(14)  =   1.0e-06  !  -      -      -     - 
    135139         rn_trfac(23)  =   7.6e-06  !  -      -      -     - 
    136        
     140 
    137141         cn_dir        =  './'      !  root directory for the location of the data files 
    138142 
  • NEMO/trunk/src/TOP/README.rst

    r11723 r11734  
    22Oceanic tracers 
    33*************** 
     4 
     5.. todo:: 
     6 
     7 
    48 
    59.. contents:: 
  • NEMO/trunk/tests/README.rst

    r11723 r11734  
    22Explore the test cases 
    33********************** 
     4 
     5.. todo:: 
     6 
     7 
    48 
    59The complete and up-to-date set of test cases is available on 
Note: See TracChangeset for help on using the changeset viewer.