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 11734 for NEMO/trunk/doc/rst/source – NEMO

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

Review README for reference confgiurations

Location:
NEMO/trunk/doc/rst/source
Files:
10 edited

Legend:

Unmodified
Added
Removed

  • 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| 
Note: See TracChangeset for help on using the changeset viewer.