- Timestamp:
- 2019-12-05T12:06:36+01:00 (4 years ago)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
NEMO/branches/2019/dev_r10742_ENHANCE-12_SimonM-Tides/README.rst
r10638 r12065 1 :Release: |version| 2 :Date: |today| 1 .. todo:: 3 2 4 NEMO_ for **Nucleus for European Modelling of the Ocean** is a state-of-the-art modelling framework for 3 4 5 NEMO_ for *Nucleus for European Modelling of the Ocean* is a state-of-the-art modelling framework for 5 6 research activities and forecasting services in ocean and climate sciences, 6 7 developed in a sustainable way by a European consortium since 2008. … … 14 15 The NEMO ocean model has 3 major components: 15 16 16 - |O PA| models the ocean {thermo}dynamics and solves the primitive equations17 ( ``./src/OCE``)18 - | SI3| simulates seaice {thermo}dynamics, brine inclusions and subgrid-scale thickness variations19 (``./src/ICE``)20 - | TOP| models the {on,off}line oceanic tracers transport and biogeochemical processes21 ( ``./src/TOP``)17 - |OCE| models the ocean {thermo}dynamics and solves the primitive equations 18 (:file:`./src/OCE`) 19 - |ICE| simulates sea-ice {thermo}dynamics, brine inclusions and 20 subgrid-scale thickness variations (:file:`./src/ICE`) 21 - |MBG| models the {on,off}line oceanic tracers transport and biogeochemical processes 22 (:file:`./src/TOP`) 22 23 23 These physical core engines are described in their respective `references`_ that 24 must be cited for any work related to their use. 24 These physical core engines are described in 25 their respective `reference publications <#project-documentation>`_ that 26 must be cited for any work related to their use (see :doc:`cite`). 25 27 26 28 Assets and solutions … … 32 34 - Create :doc:`embedded zooms<zooms>` seamlessly thanks to 2-way nesting package AGRIF_. 33 35 - Opportunity to integrate an :doc:`external biogeochemistry model<tracers>` 34 - Versatile :doc:`data assimilation<da ta_assimilation>`35 - Generation of :doc:`diagnostics<diag nostics>` through effective XIOS_ system36 - Roll-out Earth system modeling with :doc:`coupling interface<c oupling>` based on OASIS_36 - Versatile :doc:`data assimilation<da>` 37 - Generation of :doc:`diagnostics<diags>` through effective XIOS_ system 38 - Roll-out Earth system modeling with :doc:`coupling interface<cplg>` based on OASIS_ 37 39 38 Several :doc:`built-in configurations<c onfigurations>` are provided to40 Several :doc:`built-in configurations<cfgs>` are provided to 39 41 evaluate the skills and performances of the model which 40 can be used as templates for setting up a new configurations ( ``./cfgs``).42 can be used as templates for setting up a new configurations (:file:`./cfgs`). 41 43 42 The user can also checkout available :doc:`idealized test cases<test _cases>` that43 address specific physical processes (``./tests``).44 The user can also checkout available :doc:`idealized test cases<tests>` that 45 address specific physical processes (:file:`./tests`). 44 46 45 A set of :doc:`utilities <tools>` is also provided to {pre,post}process your data ( ``./tools``).47 A set of :doc:`utilities <tools>` is also provided to {pre,post}process your data (:file:`./tools`). 46 48 47 49 Project documentation … … 49 51 50 52 A walkthrough tutorial illustrates how to get code dependencies, compile and execute NEMO 51 ( ``./INSTALL.rst``) .53 (:file:`./INSTALL.rst`). 52 54 53 55 Reference manuals and quick start guide can be build from source and 54 exported to HTML or PDF formats ( ``./doc``) or55 downloaded directly from the : website:`website<bibliography/documentation>`.56 exported to HTML or PDF formats (:file:`./doc`) or 57 downloaded directly from the :forge:`development platform<wiki/Documentations>`. 56 58 57 =========== ===================== =============== 58 Component Reference Manual Quick start 59 =========== ===================== =============== 60 |OPA| |NEMO manual|_ |NEMO guide| 61 :cite:`NEMO_manual` 62 |SI3| |SI3 manual| 63 :cite:`SI3_manual` 64 |TOP| |TOP manual| 65 :cite:`TOP_manual` 66 =========== ===================== =============== 59 ============ ================== =================== 60 Component Reference Manual Quick Start Guide 61 ============ ================== =================== 62 |NEMO-OCE| |DOI man OCE|_ |DOI qsg| 63 |NEMO-ICE| |DOI man ICE| 64 |NEMO-MBG| |DOI man MBG| 65 ============ ================== =================== 67 66 68 67 Since 2014 the project has a `Special Issue`_ in the open-access journal 69 Geoscientific Model Development (GMD) from the European Geosciences Union (EGU ).68 Geoscientific Model Development (GMD) from the European Geosciences Union (EGU_). 70 69 The main scope is to collect relevant manuscripts covering various topics and 71 70 to provide a single portal to assess the model potential and evolution. … … 78 77 ================= 79 78 80 The NEMO Consortium pulling together 5 European institutes (CMCC_, CNRS_, MOI_, `Met Office`_ and NERC_) 81 plans the sustainable development in order to keep a reliable evolving framework since 2008. 79 The NEMO Consortium pulling together 5 European institutes 80 (CMCC_, CNRS_, MOI_, `Met Office`_ and NERC_) plans the sustainable development in order to 81 keep a reliable evolving framework since 2008. 82 82 83 It defines the | NEMO strategy|_ that is implemented by the System Team on a yearly basis in order to84 release a new version almost every four years.83 It defines the |DOI dev stgy|_ that is implemented by the System Team on a yearly basis 84 in order to release a new version almost every four years. 85 85 86 86 When the need arises, :forge:`working groups<wiki/WorkingGroups>` are created or resumed to 87 87 gather the community expertise for advising on the development activities. 88 88 89 .. |DOI dev stgy| replace:: multi-year development strategy 89 90 90 .. Substitutions / Links 91 Disclaimer 92 ========== 91 93 92 .. |NEMO manual| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.1464816.svg 93 .. |NEMO guide| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.1475325.svg 94 .. |SI3 manual| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.1471689.svg 95 .. |TOP manual| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.1471700.svg 94 The NEMO source code is freely available and distributed under 95 :download:`CeCILL v2.0 license <../../../LICENSE>` (GNU GPL compatible). 96 96 97 .. |NEMO strategy| replace:: multi-year development strategy 98 99 .. _Special Issue: https://www.geosci-model-dev.net/special_issue40.html 97 You can use, modify and/or redistribute the software under its terms, 98 but users are provided only with a limited warranty and the software's authors and 99 the successive licensor's have only limited liability.
Note: See TracChangeset
for help on using the changeset viewer.