Changeset 10279 for NEMO/trunk
- Timestamp:
- 2018-11-07T12:04:15+01:00 (5 years ago)
- Location:
- NEMO/trunk
- Files:
-
- 3 added
- 1 deleted
- 16 edited
- 4 moved
Legend:
- Unmodified
- Added
- Removed
-
NEMO/trunk/INSTALL.rst
r10201 r10279 1 ===================== 1 ********************* 2 2 Install the framework 3 ===================== 3 ********************* 4 4 5 .. include:: .global.rst 6 7 .. contents:: \ 5 .. contents:: 8 6 :local: 9 7 … … 24 22 ======================= 25 23 26 Download the source code 24 Download the source code 25 ------------------------ 27 26 28 27 .. code:: console … … 31 30 32 31 Description of directory tree 33 ============================= 32 ----------------------------- 34 33 35 +-----------+---------------------------------------------------------------+ 36 | Folder | Purpose | 37 +===========+===============================================================+ 38 | ``arch`` | Settings (per architecture-compiler pair) | 39 +-----------+---------------------------------------------------------------+ 40 | ``cfgs`` | Reference configurations | 41 +-----------+---------------------------------------------------------------+ 42 | ``doc`` | - ``latex``: reference manuals for NEMO, SI\ :sup:`3`\ & TOP | 43 | | - ``rst``: quick start guide | 44 +-----------+---------------------------------------------------------------+ 45 | ``ext`` | Dependencies included (AGRIF, FCM & IOIPSL) | 46 +-----------+---------------------------------------------------------------+ 47 | ``mk`` | Building routines | 48 +-----------+---------------------------------------------------------------+ 49 | ``src`` | Modelling routines | 50 | | | 51 | | - ``ICE``: SI\ :sup:`3`\ for sea ice | 52 | | - ``NST``: AGRIF for embedded zooms | 53 | | - ``OCE``: OPA for ocean dynamics | 54 | | - ``MBG``: TOP for tracers | 55 +-----------+---------------------------------------------------------------+ 56 | ``tests`` | Test cases | 57 +-----------+---------------------------------------------------------------+ 58 | ``tools`` | Utilities to [pre|post]process data | 59 +-----------+---------------------------------------------------------------+ 34 +-----------+------------------------------------------------------------+ 35 | Folder | Purpose | 36 +===========+============================================================+ 37 | ``arch`` | Settings (per architecture-compiler pair) | 38 +-----------+------------------------------------------------------------+ 39 | ``cfgs`` | :doc:`Reference configurations <configurations>` | 40 +-----------+------------------------------------------------------------+ 41 | ``doc`` | - ``latex``: reference manuals for |OPA|, |SI3| & |TOP| | 42 | | - ``namelists``: k start guide | 43 | | - ``rst``: quick start guide | 44 +-----------+------------------------------------------------------------+ 45 | ``ext`` | Dependencies included (AGRIF, FCM & IOIPSL) | 46 +-----------+------------------------------------------------------------+ 47 | ``mk`` | Building routines | 48 +-----------+------------------------------------------------------------+ 49 | ``src`` | Modelling routines | 50 | | | 51 | | - ``ICE``: |SI3| for sea ice | 52 | | - ``NST``: AGRIF for embedded zooms | 53 | | - ``OCE``: |OPA| for ocean dynamics | 54 | | - ``MBG``: |TOP| for tracers | 55 +-----------+------------------------------------------------------------+ 56 | ``tests`` | :doc:`Test cases <test_cases>` (unsupported) | 57 +-----------+------------------------------------------------------------+ 58 | ``tools`` | :doc:`Utilities <tools>` to [pre|post]process data | 59 +-----------+------------------------------------------------------------+ 60 60 61 61 Extract and install XIOS … … 121 121 .. literalinclude:: 122 122 123 -----------------124 123 Default behaviour 125 124 ----------------- … … 128 127 If –n option is not specified, ORCA2_LIM is the default configuration used. 129 128 130 -----------------------------131 129 Tools used during the process 132 130 ----------------------------- … … 136 134 bld.cfg : FCM rules to compile 137 135 138 --------139 136 Examples 140 137 -------- … … 163 160 echo "./makenemo -n MY_CONFIG -j0 add_key \"key_iomput key_mpp_mpi\" del_key \"key_agrif\" "; 164 161 165 -----------------166 162 Running the model 167 ----------------- 163 ================= 168 164 169 165 Once makenemo has run successfully, the opa executable is available in ``CONFIG/MY_CONFIG/EXP00`` … … 173 169 mpirun -n $NPROCS ./opa # $NPROCS is the number of processes ; mpirun is your MPI wrapper 174 170 175 --------------------------------------------176 171 Viewing and changing list of active CPP keys 177 -------------------------------------------- 172 ============================================ 178 173 179 174 For a given configuration (here called MY_CONFIG), the list of active CPP keys can be found in:: -
NEMO/trunk/README.rst
r10201 r10279 1 .. include:: .global.rst 2 1 :Authors: NEMO System Team 3 2 :Release: |release| 4 3 :Date: |today| 5 6 NEMO for *Nucleus for European Modelling of the Ocean* is a state-of-the-art modelling framework of 7 ocean related engines for oceanographic research, operational oceanography, seasonal forecast and 8 [paleo]climate studies. 4 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. 9 7 10 8 .. contents:: … … 14 12 ======== 15 13 16 Distributed under CeCILL license (GNU GPL compatible - see ``./LICENSE``), 17 the NEMO ocean model has 3 major components: 14 The NEMO ocean model has 3 major components: 18 15 19 - :rstblue:`OPA` is fundamental to all users by modelling the ocean [thermo]dynamics and20 solving the primitive equations (``./src/OCE``); :cite:`madec_bk08`21 - :rstgrey:`SI`\ :rstgreysup:`3` for sea-ice simulates ice [thermo]dynamics, brine inclusions and22 subgrid-scale thickness variations (``./src/ICE``); :cite:`gmd-8-2991-2015,vancoppenolle200933`23 - :rstgreen:`TOP-PISCES` models biogeochemistry with TOP for the on/offline oceanic tracers transport and24 PISCES for the biogeochemical processes (``./src/MBG``). :cite:`gmd-8-2465-2015`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`. 25 22 26 These physical engines are described in their respective reference publicationsthat must be cited for23 These physical core engines are described in their respective <reference publications> that must be cited for 27 24 any work related to their use. 28 25 … … 33 30 it offers various features to enable 34 31 35 - 2-way nesting package `AGRIF`_ to create :doc:`embedded zooms <zooms>` seamlessly 36 - Flexible biogeochemistry with :doc:`online coarsening <coarsening>` and 37 opportunity to integrate an :doc:`alternative model <tracers>` 38 - Versatile :doc:`data assimilation interface <data_assimilation>` 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. 39 37 40 lation a efficient XIOS_ server for outputing diagnostics a coupled via OASIS_ to alternative components or other models to enable Earth system modelling. 41 42 | Several :doc:`builtins configurations <reference_configurations>` are provided to assess the skills and 43 performances of the model which can be used as templates for setting up a new configuration (``./cfgs``). 44 | The end user could also find some :doc:`idealised test cases <test_cases>` on the web to serve as examples and 38 | Several :doc:`builtins configurations <configurations>` are provided to assess 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 some :doc:`idealised test cases <test_cases>` online to serve as templates and 45 41 to study particular processes (``./tests``). 46 42 47 A set of tools is also provided to setup your own configuration and[pre|post]process your data (``./tools``).43 A set of :doc:`utilities <tools>` is also provided to [pre|post]process your data (``./tools``). 48 44 49 45 Literature 50 46 ========== 51 47 52 | The NEMO reference manual and a quick start guide can be generated from Latex and RST source code files 53 (``./doc``), either in PDF or in HTML format, but it might require some additional installations. 54 | In any case, both formats are available online: `HTML`_ | `PDF`_ 48 :doc:`install` 55 49 56 | Since 2014 the project has a `Special Issue`_ in the open-access journal Geoscientific Model Development (GMD) 57 from the European Geosciences Union (EGU). 58 The main scope is to collect relevant manuscripts which cover a wide variety of topics like 59 process studies, new parameterizations, implementation of new model features and new NEMO configurations. 60 | Also it provides a single portal to search, discover and understand about 61 the NEMO modelling framework potential and evolution and to submit their contributions. 50 The reference documentation is archived online 51 52 +-------+-------------------+----------------+ 53 | | Reference manual | |NEMO manual|_ | 54 | |OPA| +-------------------+----------------+ 55 | | Quick start guide | |NEMO guide|_ | 56 +-------+-------------------+----------------+ 57 | |SI3| | |SI3 manual|_ | 58 +---------------------------+----------------+ 59 | |TOP| | |TOP manual|_ | 60 +---------------------------+----------------+ 61 62 .. |NEMO manual| image:: http://zenodo.org/badge/DOI/10.5281/zenodo.1464816.svg 63 .. |NEMO guide| image:: http://zenodo.org/badge/DOI/10.5281/zenodo.1475325.svg 64 .. |SI3 manual| image:: http://zenodo.org/badge/DOI/10.5281/zenodo.1471689.svg 65 .. |TOP manual| image:: http://zenodo.org/badge/DOI/10.5281/zenodo.1471700.svg 66 67 | Reference manuals and quick start guide can be build from source and exported to HTML or PDF (``./doc``). 68 | In any case, one can find them online: 69 70 Since 2014 the project has a `Special Issue <http://www.geosci-model-dev.net/special_issue40.html>`_ in 71 the open-access journal Geoscientific Model Development (GMD) from the European Geosciences Union (EGU). 72 The main scope is to collect relevant manuscripts covering various topics and to provide a single portal to 73 assess the model potential and evolution. 74 75 Used by a wide audience, numerous :website:`associated projects <projects>` have been carried out and 76 extensive :website:`bibliography <bibliography/publications>` published. 62 77 63 78 Community development 64 79 ===================== 65 80 66 | The NEMO Consortium gathering 6 European institutes (`CMCC`_, `CNRS`_, `MOI`_, `Met Office`_ and `NERC`_) 67 organises the sustainable development in order to keep a reliable evolving system since 2008. 68 | It defines the multi-year development strategy which is implemented by the NEMO System Team. 81 | The NEMO Consortium pulling together 5 European institutes (`CMCC`_, `CNRS`_, `MOI`_, `Met Office`_ and `NERC`_) 82 plans the sustainable development in order to keep a reliable evolving framework since 2008. 83 | It defines the |NEMO strategy|_ which is implemented by the System Team on 84 a yearly basis in order to release a new version almost every four years. 69 85 70 When the need arises, `Working Groups`_ are created or resumed to gather the expertise in the community in order to 71 focus the development work on a specific subject or major component of the framework. 86 .. |NEMO strategy| replace:: multi-year development strategy 72 87 73 How to cite NEMO 74 ================ 75 76 .. bibliography:: references.bib 77 :all: 78 :style: unsrt 79 80 .. _HTML: http://www.nemo-ocean.eu/doc 81 .. _PDF: http://www.nemo-ocean.eu/wp-content/uploads/NEMO_book.pdf 88 When the need arises, :forge:`working groups <wiki/WorkingGroups>` are created or resumed to 89 gather the community expertise for advising on the development activities. -
NEMO/trunk/REFERENCES.bib
r10201 r10279 1 @Book{madec_bk08, 2 title = {NEMO ocean engine}, 3 publisher = {Note du P\^ole de mod{\'e}lisation, Institut Pierre-Simon Laplace 4 (IPSL), France, No 27, ISSN No 1288-1619}, 5 year = {2008}, 6 author = {G. Madec and NEMO System Team} 1 @manual{NEMO_manual, 2 title={NEMO ocean engine}, 3 author={Madec Gurvan and NEMO System Team}, 4 organization={NEMO Consortium}, 5 journal={Notes du Pôle de modélisation de l\'Institut Pierre-Simon Laplace (IPSL)}, 6 number={27}, 7 publisher={Zenodo}, 8 abstract={The ocean engine of NEMO is a primitive equation model adapted to regional and 9 global ocean circulation problems. 10 It is intended to be a flexible tool for studying the ocean and its interactions with 11 the others components of the earth climate system over a wide range of space and time scales.}, 12 doi={10.5281/zenodo.1464816}, 13 edition={}, 14 year={} 7 15 } 8 16 9 @Article{gmd-8-2465-2015, 10 author = {Aumont, O. and Eth\'e, C. and Tagliabue, A. and Bopp, L. and Gehlen, M.}, 11 title = {{PISCES}-v2: an ocean biogeochemical model for carbon and ecosystem studies}, 12 journal = {Geoscientific Model Development}, 13 volume = {8}, 14 year = {2015}, 15 number = {8}, 16 pages = {2465--2513}, 17 doi = {10.5194/gmd-8-2465-2015} 17 @manual{SI3_manual, 18 title={SI³ – Sea Ice modelling Integrated Initiative – The NEMO Sea Ice engine}, 19 author={NEMO Sea Ice Working Group}, 20 organization={NEMO Consortium}, 21 journal={Notes du Pôle de modélisation de l\'Institut Pierre-Simon Laplace (IPSL)}, 22 number={31}, 23 publisher={Zenodo}, 24 abstract={SI³ (Sea Ice modelling Integrated Initiative) is the sea ice engine of NEMO 25 (Nucleus for European Modelling of the Ocean). 26 It is adapted to regional and global sea ice and climate problems. 27 It is intended to be a flexible tool for studying sea ice and its interactions with 28 the other components of the Earth System over a wide range of space and time scales. 29 SI3 is based on the Arctic Ice Dynamics Joint EXperiment (AIDJEX) framework, 30 combining the ice thickness distribution framework, the conservation of horizontal momentum, 31 an elastic-viscous plastic rheology, and energy-conserving halo-thermodynamics. 32 Prognostic variables are the two-dimensional horizontal velocity field, ice volume, area, enthalpy, 33 salt content, snow volume and enthalpy. 34 In the horizontal direction, the model uses a curvilinear orthogonal grid. 35 In the vertical direction, the model uses equally-spaced layers. 36 In thickness space, the model uses thickness categories with prescribed boundaries. 37 Various physical and numerical choices are available to describe sea ice physics. 38 SI3 is interfaced with the NEMO ocean engine, and, via the OASIS coupler, with 39 several atmospheric general circulation models. 40 It also supports two-way grid embedding via the AGRIF software.}, 41 doi={10.5281/zenodo.1471689}, 42 edition={}, 43 year={} 44 } 45 46 @manual{TOP_manual, 47 title={TOP – Tracers in Ocean Paradigm – The NEMO Tracers engine}, 48 author={NEMO TOP Working Group}, 49 organization={NEMO Consortium}, 50 journal={Notes du Pôle de modélisation de l\'Institut Pierre-Simon Laplace (IPSL)}, 51 number={28}, 52 publisher={Zenodo}, 53 abstract={}, 54 doi={10.5281/zenodo.1471700}, 55 edition={}, 56 year={} 18 57 } 19 58 … … 28 67 doi = {10.5194/gmd-8-1245-2015} 29 68 } 30 31 @Article{gmd-8-2991-2015,32 author = {Rousset, C. and Vancoppenolle, M. and Madec, G. and Fichefet, T. and Flavoni, S. and Barth\'elemy, A. and Benshila, R. and Chanut, J. and Levy, C. and Masson, S. and Vivier, F.},33 title = {The {L}ouvain-la-{N}euve sea ice model {LIM}3.6: global and regional capabilities},34 journal = {Geoscientific Model Development},35 volume = {8},36 year = {2015},37 number = {10},38 pages = {2991--3005},39 doi = {10.5194/gmd-8-2991-2015}40 }41 42 @Article{vancoppenolle200933,43 title = "Simulating the mass balance and salinity of Arctic and Antarctic sea ice. 1. Model description and validation",44 journal = "Ocean Modelling",45 volume = "27",46 number = "1–2",47 pages = "33 - 53",48 year = "2009",49 issn = "1463-5003",50 doi = "10.1016/j.ocemod.2008.10.005",51 author = "Martin Vancoppenolle and Thierry Fichefet and Hugues Goosse and Sylvain Bouillon and Gurvan Madec and Miguel Angel Morales Maqueda",52 keywords = "sea ice, model, thickness, salinity, age, arctic, antarctic"53 } -
NEMO/trunk/RELEASE_NOTES.rst
r10201 r10279 1 ====================== 1 ********************** 2 2 What's new in NEMO 4.0 3 ====================== 4 5 .. include:: .global.rst 3 ********************** 6 4 7 5 .. contents:: … … 208 206 .. _TOP User Quick Guide: http://forge.ipsl.jussieu.fr/nemo/wiki/WorkingGroups/top-dg/TOP-UserQuickGuide 209 207 208 .. The following references should be in the manual bibliographies and referenced via 'bibliography' directive 210 209 .. _Brodeau 2017: http://doi.org/10.1175/JPO-D-16-0169.1 211 210 .. _Holland 2012: http://doi.org/10.1175/JCLI-D-11-00078.1 -
NEMO/trunk/cfgs/AGRIF_DEMO/README.rst
r10201 r10279 1 Embedded zooms with AGRIF 2 ========================= 3 4 .. include:: .global.rst 1 ********************** 2 Embedded zooms (AGRIF) 3 ********************** 5 4 6 5 .. contents:: 7 6 :local: 8 7 9 --------10 8 Overview 11 -------- 9 ======== 12 10 13 11 AGRIF (Adaptive Grid Refinement In Fortran) is a library that allows the seamless space and time refinement over … … 19 17 For a more technical description of the library itself, please refer to http://agrif.imag.fr. 20 18 21 -----------22 19 Compilation 23 ----------- 20 =========== 24 21 25 22 Activating AGRIF requires to append the cpp key ``key_agrif`` at compilation time: … … 34 31 saved arrays may be switched in memory space from one domain to an other. 35 32 36 --------------------------------37 33 Definition of the grid hierarchy 38 -------------------------------- 34 ================================ 39 35 40 36 An additional text file ``AGRIF_FixedGrids.in`` is required at run time. … … 68 64 Defining for instance a circumpolar zoom in a global model is therefore not possible. 69 65 70 -------------71 66 Preprocessing 72 ------------- 67 ============= 73 68 74 69 Knowing the refinement factors and area, a ``NESTING`` pre-processing tool may help to create needed input files … … 79 74 These correspond to the namelists used to create ``AGRIF_DEMO`` inputs. 80 75 81 ----------------82 76 Namelist options 83 ---------------- 77 ================ 84 78 85 79 Each child grid expects to read its own namelist so that different numerical choices can be made … … 104 98 2 x refinement factor (from i=1+nbghostcells+1 to i=1+nbghostcells+sponge_area) 105 99 106 ----------107 100 References 108 ---------- 101 ========== 109 102 110 103 .. bibliography:: zooms.bib 111 104 :all: 112 105 :style: unsrt 106 :labelprefix: A 107 :keyprefix: a- -
NEMO/trunk/cfgs/AGRIF_DEMO/zooms.bib
r10201 r10279 1 @article{DEBREU2012 1,1 @article{DEBREU2012, 2 2 title = "Two-way nesting in split-explicit ocean models: Algorithms, implementation and validation", 3 3 journal = "Ocean Modelling", … … 11 11 } 12 12 13 @article{PENVEN2006 157,13 @article{PENVEN2006, 14 14 title = "Evaluation and application of the {ROMS} 1-way embedding procedure to the central california upwelling system", 15 15 journal = "Ocean Modelling", … … 24 24 } 25 25 26 @article{ doi:10.1175/1520-0485(1991)021<0205:ANPEMF>2.0.CO;2,26 @article{SPALL1991, 27 27 author = {Spall, Michael A. and Holland, William R.}, 28 28 title = {A Nested Primitive Equation Model for Oceanic Applications}, -
NEMO/trunk/cfgs/README.rst
r10201 r10279 1 ===================== 2 Build a configuration 3 ===================== 4 5 .. include:: .global.rst 1 ***************************** 2 Run a reference configuration 3 ***************************** 6 4 7 5 .. contents:: … … 9 7 :depth: 1 10 8 11 .. role:: underline12 :class: underline13 14 9 Official configurations 15 10 ======================= … … 47 42 +----------------------+-----+-----+-----+--------+-------+-------------------------------+ 48 43 49 ----------50 44 AGRIF_DEMO 51 45 ---------- … … 78 72 0 79 73 80 -----81 74 AMM12 82 75 ----- … … 101 94 Unlike ordinary river points the Baltic inputs also include salinity and temperature data. 102 95 103 --------104 96 C1D_PAPA 105 97 -------- … … 127 119 - surface chlorophyll file (``chlorophyll_PAPASTATION.nc``) deduced from Seawifs data. 128 120 129 --------130 121 GYRE_BFM 131 122 -------- … … 134 125 BFM biogeochemichal model in coupled mode. 135 126 136 -----------137 127 GYRE_PISCES 138 128 ----------- … … 145 135 146 136 Running GYRE as a benchmark 147 --------------------------- 137 ^^^^^^^^^^^^^^^^^^^^^^^^^^^ 148 138 149 139 This simple configuration can be used as a benchmark since it is easy to increase resolution … … 206 196 http://prodn.idris.fr/thredds/catalog/ipsl_public/reee451/NEMO_OUT/GYRE/catalog.html 207 197 208 ----------------209 198 ORCA2_ICE_PISCES 210 199 ---------------- … … 293 282 `COREII`_ forcing files extrapolated on continents 294 283 295 ----------------296 284 ORCA2_OFF_PISCES 297 285 ---------------- … … 305 293 They are coming from a 2000 years of an ORCA2_LIM climatological run using ERA40 atmospheric forcing. 306 294 307 -------------308 295 ORCA2_OFF_TRC 309 296 ------------- … … 320 307 ERA40 atmospheric forcing. 321 308 322 -------------323 309 ORCA2_SAS_ICE 324 310 ------------- … … 335 321 Same input files as `ORCA2_ICE_PISCES`_ are needed plus fields from a previous ORCA2_LIM run. 336 322 337 More informations on input and configuration files in `NEMO Reference manual`_. 338 339 ------- 323 More informations on input and configuration files in `NEMO manual`_. 324 340 325 SPITZ12 341 326 ------- … … 358 343 .. _ORCA2_ICE_v4.0.tar: http://prodn.idris.fr/thredds/fileServer/ipsl_public/romr005/Online_forcing_archives/ORCA2_ICE_v4.0.tar 359 344 .. _INPUTS_SAS_v4.0.tar: http://prodn.idris.fr/thredds/fileServer/ipsl_public/romr005/Online_forcing_archives/INPUTS_SAS_v4.0.tar 360 .. _NEMO Reference manual: http://forge.ipsl.jussieu.fr/nemo/doxygen/index.html?doc=NEMO361 345 .. _INPUTS_C1D_PAPA_v4.0.tar: http://prodn.idris.fr/thredds/fileServer/ipsl_public/romr005/Online_forcing_archives/INPUTS_C1D_PAPA_v4.0.tar 362 346 .. _Reffray 2015: http://www.geosci-model-dev.net/8/69/2015 -
NEMO/trunk/cfgs/SHARED/README.rst
r10201 r10279 1 Inputs-Outputs with XIOS 2 ======================== 3 4 .. include:: .global.rst 1 ****************** 2 Diagnostics (XIOS) 3 ****************** 5 4 6 5 .. contents:: 6 :local: 7 7 8 8 | Output of diagnostics in NEMO is usually done using XIOS. … … 10 10 some simple arithmetic or regridding is carried out in parallel to the NEMO model run. 11 11 | This page gives a basic introduction to using XIOS with NEMO. 12 Much more information is available from the XIOS homepage above and from the ` Reference Manual`_.12 Much more information is available from the XIOS homepage above and from the `NEMO manual`_. 13 13 14 14 Use of XIOS for diagnostics is activated using the pre-compiler key ``key_iomput``. 15 15 The default version of XIOS is the 2.0 release. 16 16 17 ------------------------------18 17 Extracting and installing XIOS 19 ------------------------------ 18 ============================== 20 19 21 20 1. Install the NetCDF4 library. … … 28 27 $ svn co http://forge.ipsl.jussieu.fr/ioserver/svn/XIOS/branchs/xios-2.0 xios-2.0 29 28 30 and follow the instructions in `XIOS documentation`_ to compile it. 31 If you find problems at this stage, support can be found by subscribing to the `XIOS users mailing list`_ and 32 sending a mail message to it. 29 and follow the instructions in :xios:`XIOS documentation <wiki/documentation>` to compile it. 30 If you find problems at this stage, support can be found by subscribing to the `XIOS mailing list 31 <http://forge.ipsl.jussieu.fr/mailman/listinfo.cgi/xios-users>`_ 32 and sending a mail message to it. 33 33 34 ---------35 34 Namelists 36 --------- 35 ========= 37 36 38 37 XIOS is controlled using xml input files that should be copied to your model run directory before … … 47 46 Note that the ``domain_def.xml`` file is also different for XIOS 2.0. 48 47 49 -----50 48 Modes 51 ----- 49 ===== 52 50 53 51 Detached Mode … … 81 79 the total number of cores is larger than the number of grid points in the j direction then the model run will fail. 82 80 83 ------------------------------ 84 Adding new diagnostics to NEMO 85 ------------------------------ 81 Adding new diagnostics 82 ====================== 86 83 87 84 If you want to add a NEMO diagnostic to the NEMO code you will need to do the following: -
NEMO/trunk/doc/rst/source/NEMO_guide.rst
r10201 r10279 1 .. NEMO documentation master file, created by2 sphinx-quickstart on Tue Oct 9 18:14:01 2018.3 You can adapt this file completely to your liking, but it should at least4 contain the root `toctree` directive.5 6 1 ################# 7 2 Quick Start Guide … … 9 4 10 5 .. 11 A hidden .global.rst should be included in every subfiles with `include` directive 12 It contains a list of common URL links 13 14 .. include:: .global.rst 15 16 .. include:: readme.rst 17 18 Summary 19 ======= 20 21 .. toctree:: 22 :maxdepth: 1 23 :titlesonly: 24 25 release_notes.rst 26 install.rst 27 reference_configurations.rst 28 test_cases.rst 29 setup_configuration.rst 30 interfacing_options.rst 31 definitions.rst 32 33 .. 34 For headings markup, this convention is recommended from Python’s Style Guide 6 For headings markup, this convention is recommended from Python’s Style Guide 35 7 # with overline, for parts 36 8 * with overline, for chapters … … 40 12 ", for paragraphs 41 13 42 .. 43 Indices and tables 44 ================== 45 * :ref:`genindex` 46 * :ref:`modindex` 47 * :ref:`search` 14 'global.rst' contains a list of common directives (roles, substitutions and URL links) 15 It is loaded for each file thanks to 'rst_epilog' setting in 'conf.py' 16 17 .. toctree:: 18 :hidden: 19 20 release_notes.rst 21 22 .. toctree:: 23 :hidden: 24 :caption: Getting started 25 26 install 27 configurations 28 test_cases 29 30 .. toctree:: 31 :hidden: 32 :caption: Setup your configuration 33 34 setup 35 diagnostics 36 tools 37 38 .. toctree:: 39 :hidden: 40 :caption: Advanced use 41 42 zooms 43 coarsening 44 coupling 45 assimilation 46 tracers 47 48 .. toctree:: 49 :hidden: 50 :caption: Glossary 51 52 definitions 53 54 .. include:: readme.rst 55 56 .. Next headings markup acording to readme.rst 57 58 How to cite NEMO 59 ================ 60 61 .. bibliography:: references.bib 62 :all: 63 :style: unsrt 64 :labelprefix: R 65 66 Disclaimer 67 ========== 68 69 The NEMO source code is freely available and distributed under CeCILL license 70 (GNU GPL compatible - see ``./LICENSE``). 71 72 You can use, modify and/or redistribute the software under its terms, 73 but users are provided only with a limited warranty and the software's authors and 74 the successive licensor's have only limited liability. -
NEMO/trunk/doc/rst/source/assimilation.rst
r10258 r10279 1 Data assimilation 2 ================= 3 4 .. include:: .global.rst 1 ************************************** 2 Data assimilation (OBS/SAO, ASM & TAM) 3 ************************************** 5 4 6 5 .. contents:: … … 12 11 - TAM the tangent linear and adjoint model. 13 12 14 Please see the `NEMO referencemanual`_ for more details including information about the input file formats and13 Please see the `NEMO manual`_ for more details including information about the input file formats and 15 14 the namelist settings. 16 15 17 --------------------------------------18 16 Observation and model comparison (OBS) 19 -------------------------------------- 17 ====================================== 20 18 21 19 The observation and model comparison code (OBS) reads in observation files (profile temperature and salinity, … … 28 26 To build with the OBS code active ``key_diaobs`` must be set. 29 27 30 More details in the `NEMO referencemanual`_ chapter 12.28 More details in the `NEMO manual`_ chapter 12. 31 29 32 30 Standalone observation operator (SAO) … … 43 41 This is a special version of ``nemogcm.F90`` (which doesn't run the model, but reads in the model fields, and 44 42 observations and runs the OBS code. 45 See section 12.4 of the `NEMO referencemanual`_.43 See section 12.4 of the `NEMO manual`_. 46 44 47 -----------------------------------48 45 Apply assimilation increments (ASM) 49 ----------------------------------- 46 =================================== 50 47 51 48 The ASM code adds the functionality to apply increments to the model variables: … … 56 53 To build the ASM code ``key asminc`` must be set. 57 54 58 More details in the `NEMO referencemanual`_ chapter 13.55 More details in the `NEMO manual`_ chapter 13. 59 56 60 --------------------------------61 57 Tangent linear and adjoint (TAM) 62 -------------------------------- 58 ================================ 63 59 64 60 This is the tangent linear and adjoint code of NEMO which is useful to 4D VAR assimilation. 65 66 .. _NEMO reference manual: http://doi.org/10.5281/zenodo. -
NEMO/trunk/doc/rst/source/conf.py
r10201 r10279 21 21 22 22 project = 'NEMO' 23 copyright = ' 2018, NEMO System Team'23 copyright = '' 24 24 author = 'NEMO System Team' 25 25 … … 39 39 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom 40 40 # ones. 41 extensions = ['sphinx contrib.bibtex']41 extensions = ['sphinx.ext.extlinks', 'sphinxcontrib.bibtex'] 42 42 43 43 # Add any paths that contain templates here, relative to this directory. … … 63 63 # directories to ignore when looking for source files. 64 64 # This pattern also affects html_static_path and html_extra_path . 65 exclude_patterns = [ ]65 exclude_patterns = ['global.rst'] 66 66 67 67 # The name of the Pygments (syntax highlighting) style to use. … … 74 74 # a list of builtin themes. 75 75 # 76 html_theme = 'alabaster' 76 #html_theme = 'alabaster' 77 html_theme = 'sphinx_rtd_theme' 77 78 78 79 # Theme options are theme-specific and customize the look and feel of a theme … … 81 82 # 82 83 html_theme_options = { 83 'logo': 'NEMO_grey.png', 84 'description': 'Community ocean model for multifarious space and time scales', 85 'fixed_sidebar': 'true', 86 # 'github_user': 'NEMO-ocean', 87 # 'github_repo': 'NEMO-examples', 88 # 'github_button': 'true', 89 # 'github_banner': 'true' 84 # Alabaster theme options 85 # 'logo': 'NEMO_grey.png', 86 # 'description': 'Community ocean model for multifarious space and time scales', 87 # 'fixed_sidebar': True, 90 88 } 91 89 … … 162 160 'Miscellaneous'), 163 161 ] 162 163 164 # -- Customisation ----------------------------------------------------------- 165 166 import datetime 167 year = datetime.date.today().year 168 copyright = '2008-' + str( year ) + ', NEMO Consortium' 169 170 # Link aliases 171 extlinks = { 172 'doi' : ('http://doi.org/%s' , None), 173 'forge' : ('http://forge.ipsl.jussieu.fr/nemo/%s' , None), 174 'github' : ('http://github.com/%s' , None), 175 'xios' : ('http://forge.ipsl.jussieu.fr/ioserver/%s', None), 176 'website': ('http://www.nemo-ocean.eu/%s' , None), 177 'zenodo' : ('http://zenodo.org/publication/%s' , None) 178 } 179 180 # Include common directives for every rst file 181 rst_epilog = open('global.rst', 'r').read() -
NEMO/trunk/doc/rst/source/coupling.rst
r10201 r10279 1 Coupling with other models (OASIS, SAS, ...) 2 ============================================ 3 4 .. include:: .global.rst 1 ********************** 2 Coupling (OASIS & SAS) 3 ********************** 5 4 6 5 NEMO currently exploits OASIS-3-MCT to implement a generalised coupled interface -
NEMO/trunk/doc/rst/source/definitions.rst
r10201 r10279 1 =========== 1 *********** 2 2 Definitions 3 =========== 3 *********** 4 4 5 .. include:: .global.rst 6 7 AGRIF 5 `AGRIF`_ 8 6 *Adaptive Grid Refinement In Fortran*, 9 7 package for the integration of full adaptive mesh refinement features within … … 14 12 unified sea ice model merging functionalities from CICE, GELATO and LIM into the NEMO framework 15 13 16 OASIS 14 `OASIS`_ 17 15 *Ocean Atmosphere Sea Ice Soil*, 18 16 coupling software to synchronise numerical codes representing different components of the climate system … … 31 29 on/off-line oceanic tracers transport and biogeochemistry models 32 30 33 XIOS 31 `XIOS`_ 34 32 *XML Input Output Server*, 35 33 library dedicated to input/output management of climate code -
NEMO/trunk/doc/rst/source/global.rst
r10277 r10279 1 .. Roles (custom styles related to CSS classes )1 .. Roles (custom styles related to CSS classes in 'source/_static/style.css') 2 2 3 3 .. role:: rstblue … … 5 5 .. role:: rstgrey 6 6 .. role:: rstgreysup(sup) 7 .. role:: underline 8 :class: underline 7 9 8 .. Links10 .. Substitutions 9 11 10 .. Institutes 12 .. |OPA| replace:: :rstblue:`NEMO-OPA` 13 .. |SI3| replace:: :rstgrey:`NEMO-SI`\ :rstgreysup:`3` 14 .. |TOP| replace:: :rstgreen:`NEMO-TOP/PISCES` 15 16 .. Institutes 11 17 12 18 .. _CMCC: http://www.cmcc.it … … 17 23 .. _NERC: http://nerc.ukri.org 18 24 19 25 .. Models / Softwares 20 26 21 27 .. _AGRIF: http://agrif.imag.fr 22 28 .. _OASIS: http://verc.enes.org/oasis 29 .. _XIOS: http://forge.ipsl.jussieu.fr/ioserver 23 30 24 31 .. NEMO 25 32 26 .. _NEMO: http://www.nemo-ocean.eu 27 .. _Reference Manual: http://doi.org/10.5281/zenodo.1137733 28 .. _Special Issue: http://www.geosci-model-dev.net/special_issue40.html 29 .. _Working Groups: http://forge.ipsl.jussieu.fr/nemo/wiki/WorkingGroups 30 31 .. XIOS 32 33 .. _XIOS: http://forge.ipsl.jussieu.fr/ioserver 34 .. _XIOS documentation: http://forge.ipsl.jussieu.fr/ioserver/wiki/documentation 35 .. _XIOS users mailing list: http://forge.ipsl.jussieu.fr/mailman/listinfo.cgi/xios-users 33 .. _NEMO: http://www.nemo-ocean.eu 34 .. _NEMO strategy: http://doi.org/10.5281/zenodo.1471663 35 .. _NEMO guide: http://doi.org/10.5281/zenodo.1475325 36 .. _NEMO manual: http://doi.org/10.5281/zenodo.1464816 37 .. _SI3 manual: http://doi.org/10.5281/zenodo.1471689 38 .. _TOP manual: http://doi.org/10.5281/zenodo.1471700 -
NEMO/trunk/doc/rst/source/interfacing_options.rst
r10201 r10279 3 3 =================== 4 4 5 .. include:: .global.rst 6 7 .. contents:: 5 .. 6 contents:: 8 7 :local: 9 8 :depth: 1 10 9 11 10 .. include:: zooms.rst 11 12 .. bibliography:: zooms.bib 13 :all: 14 :style: unsrt 15 :labelprefix: A 16 :keyprefix: a- 12 17 13 18 ---- … … 21 26 ---- 22 27 23 .. include:: data_assimilation.rst28 .. include:: assimilation.rst 24 29 25 30 ---- -
NEMO/trunk/src/OCE/CRS/README.rst
r10201 r10279 1 ********************************** 1 2 On line biogeochemistry coarsening 2 ================================== 3 4 .. include:: .global.rst 3 ********************************** 5 4 6 5 .. contents:: 7 6 :local: 8 7 9 .. role:: underline10 :class: underline11 12 ------------13 8 Presentation 14 ------------ 9 ============ 15 10 16 11 A capacity of coarsening physics to force a BGC model coupled to NEMO has been developed. … … 20 15 A presentation is available [attachment:crs_wiki_1.1.pdf here], where the methodology is presented. 21 16 22 -----------------------------------------------------23 17 What is available and working for now in this version 24 ----------------------------------------------------- 18 ===================================================== 25 19 26 20 [To be completed] 27 21 28 ----------------------------------------------29 22 Description of the successful validation tests 30 ---------------------------------------------- 23 ============================================== 31 24 32 25 [To be completed] 33 26 34 ------------------------------------------------------------------35 27 What is not working yet with on line coarsening of biogeochemistry 36 ------------------------------------------------------------------ 28 ================================================================== 37 29 38 30 [To be completed] … … 40 32 ''should include precise explanation on MPI decomposition problems too'' 41 33 42 ---------------------------------------------43 34 How to set up and use on line biogeochemistry 44 --------------------------------------------- 35 ============================================= 45 36 46 :underline:`How to activate coarsening?` 37 Extract the on line biogeochemistry branch 38 ------------------------------------------ 39 40 To get the appropriate source code with the on line coarsening of biogeochemistry feature: 41 42 .. code-block:: console 43 44 $ svn co https://forge.ipsl.jussieu.fr/nemo/browser/NEMO/branches/2018/dev_r5003_MERCATOR6_CRS 45 46 47 How to activate coarsening? 48 --------------------------- 47 49 48 50 To activate the coarsening, ``key_crs`` should be added to list of CPP keys. … … 83 85 so only works when ``key_top`` is in the cpp list and eventually ``key_pisces`` or ``key_my_trc``. 84 86 85 :underline:`Choice of operator to coarsene KZ` 87 Choice of operator to coarsene KZ 88 --------------------------------- 86 89 87 90 A sensiblity test has been done with an Age tracer to compare the different operators. … … 90 93 Some results can be found [xxx here] 91 94 92 :underline:`Example of xml files to output coarsened variables with XIOS` 95 Example of xml files to output coarsened variables with XIOS 96 ------------------------------------------------------------ 93 97 94 98 In the [attachment:iodef.xml iodef.xml] file, a "nemo" context is defined and … … 98 102 the associated variable are listed in [attachment:file_crs_def.xml file_crs_def.xml ]. 99 103 100 :underline:`Passive tracers tracers initial conditions` 104 Passive tracers tracers initial conditions 105 ------------------------------------------ 101 106 102 107 When initial conditions are provided in NetCDF files, the field might be: … … 132 137 cn_dir = './' ! root directory for the location of the data files 133 138 134 :underline:`PISCES forcing files` 139 PISCES forcing files 140 -------------------- 135 141 136 142 They might be on the coarsened grid. 137 143 138 :underline:`Perspectives` 144 Perspectives 145 ============ 139 146 140 147 For the future, a few options are on the table to implement coarsening for biogeochemistry in 4.0 and -
NEMO/trunk/src/TOP/README.rst
r10201 r10279 1 TOP interface 2 ============= 3 4 .. include:: .global.rst 1 ********************* 2 Oceanic tracers (TOP) 3 ********************* 5 4 6 5 .. contents:: … … 17 16 up to the full set of equations involving marine biogeochemical cycles. 18 17 19 ---------20 18 Structure 21 --------- 19 ========= 22 20 23 21 TOP interface has the following location in the source code ``./src/MBG/`` and … … 73 71 trend computation for tracers 74 72 75 ------------------76 73 Synthetic Workflow 77 ------------------ 74 ================== 78 75 79 76 A synthetic description of the TOP interface workflow is given below to summarize the steps involved in … … 125 122 ↳ call trc_rst_wri, output tracers restart files 126 123 127 ---------------------128 124 Namelists walkthrough 129 --------------------- 125 ===================== 130 126 131 127 namelist_top … … 235 231 |||| &'''namc14_fcg''' ! files & dates || 236 232 237 -----------------------------------------------------238 233 ``MY_TRC`` interface for coupling external BGC models 239 ----------------------------------------------------- 234 ===================================================== 240 235 241 236 The generalized interface is pivoted on MY_TRC module that contains template files to build the coupling between … … 277 272 if not done elsewhere in the code, using the call to iom_put. 278 273 279 ---------------------------------------------------280 274 Coupling an external BGC model using NEMO framework 281 --------------------------------------------------- 275 =================================================== 282 276 283 277 The coupling with an external BGC model through the NEMO compilation framework can be achieved in -
NEMO/trunk/tests/README.rst
r10240 r10279 1 ====================== 1 ********************** 2 2 Explore the test cases 3 ====================== 3 ********************** 4 5 .. contents:: 6 :local: 7 8 List 9 ==== 4 10 5 11 The description below is a brief description of the test cases available in NEMO. 6 For detailed description and notebook, the reader is directed on the `Github repository`_7 8 .. _Github repository: https://github.com/sflavoni/NEMO-test-cases/9 12 10 13 ICEDYN 11 ====== 14 ------ 12 15 13 16 This test case illustrates the advection of an ice patch across a East/West and North/South periodic channel. … … 19 22 20 23 VORTEX 21 ====== 24 ------ 22 25 23 26 This test case illustrates the propagation of an anticyclonic eddy over a Beta plan and a flat bottom. … … 32 35 33 36 ISOMIP 34 ====== 37 ------ 35 38 36 39 The purpose of this test case is to evaluate the impact of various schemes and new development with the iceshelf cavities circulation and melt. … … 43 46 44 47 LOCK_EXCHANGE 45 ============= 48 ------------- 46 49 47 50 The LOCK EXCHANGE experiment is a classical fluid dynamics experiment that has been adapted … … 56 59 57 60 OVERFLOW 58 ======== 61 -------- 59 62 60 63 The OVERFLOW experiment illustrates the impact of different choices of numerical schemes … … 69 72 70 73 WAD 71 === 74 --- 72 75 73 76 A set of simple closed basin geometries for testing the Wetting and drying capabilities. … … 81 84 82 85 CANAL 83 ===== 86 ----- 84 87 85 88 East-west periodic canal of variable size with several initial states and associated geostrophic currents (zonal jets or vortex). … … 87 90 .. image::_static/CANAL_image.gif 88 91 89 ==================90 92 Compile test cases 91 93 ================== 94 92 95 The compilation of the test cases is very similar to the manner the reference configurations are compiled. 93 If you are not familiar on how to compile NEMO, it is first recomended to read the instruction 94 `here <http://forge.ipsl.jussieu.fr/nemo/wiki/Users/ModelInstall>`_ 96 If you are not familiar on how to compile NEMO, it is first recomended to read :doc:`the instructions <install>` 95 97 96 98 | In the same manner as the ref. cfg are compiled with '-r' option, test cases can be compile by the use of makenemo with '-a' option. … … 99 101 100 102 .. code-block:: console 101 102 103 104 $ ./makenemo -n WAD2 -a WAD -m macport_osx -j 4 103 105 104 =====================================105 106 Run and analyse the test cases 106 ===================================== 107 ============================== 108 107 109 There no requirement of specific input file for the test_cases presented here. The XIOS xml input files and namelist are already setup correctly. 108 All the detailed on how to run a specific test cases and Jupyter notebook are available on github `here <https://github.com/sflavoni/NEMO-test-cases>`_. 110 For detailed description and Jupyter notebook, the reader is directed on 111 the `NEMO test cases repository <http://github.com/NEMO-ocean/NEMO-examples>`_ 109 112 110 ==========111 113 References 112 114 ========== 113 115 114 .. bibliography:: test_cases.bib 115 :all: 116 :style: unsrt 116 .. bibliography:: test_cases.bib 117 :all: 118 :style: unsrt 119 :labelprefix: T
Note: See TracChangeset
for help on using the changeset viewer.