source: NEMO/trunk/README.rst @ 11723

Last change on this file since 11723 was 11723, checked in by nicolasmartin, 14 months ago

Review of INSTALL.rst

File size: 3.8 KB
Line 
1NEMO_ for *Nucleus for European Modelling of the Ocean* is a state-of-the-art modelling framework for
2research activities and forecasting services in ocean and climate sciences,
3developed in a sustainable way by a European consortium since 2008.
4
5.. contents::
6   :local:
7
8Overview
9========
10
11The NEMO ocean model has 3 major components:
12
13- |OCE| models the ocean {thermo}dynamics and solves the primitive equations
14  (:file:`./src/OCE`)
15- |ICE| simulates sea-ice {thermo}dynamics, brine inclusions and
16  subgrid-scale thickness variations (:file:`./src/ICE`)
17- |MBG| models the {on,off}line oceanic tracers transport and biogeochemical processes
18  (:file:`./src/TOP`)
19
20These physical core engines are described in
21their respective `reference publications <#project-documentation>`_ that
22must be cited for any work related to their use (see :doc:`cite`).
23
24Assets and solutions
25====================
26
27Not only does the NEMO framework model the ocean circulation,
28it offers various features to enable
29
30- Create :doc:`embedded zooms<zooms>` seamlessly thanks to 2-way nesting package AGRIF_.
31- Opportunity to integrate an :doc:`external biogeochemistry model<tracers>`
32- Versatile :doc:`data assimilation<da>`
33- Generation of :doc:`diagnostics<diags>` through effective XIOS_ system
34- Roll-out Earth system modeling with :doc:`coupling interface<cplg>` based on OASIS_
35
36Several :doc:`built-in configurations<cfgs>` are provided to
37evaluate the skills and performances of the model which
38can be used as templates for setting up a new configurations (:file:`./cfgs`).
39
40The user can also checkout available :doc:`idealized test cases<tests>` that
41address specific physical processes (:file:`./tests`).
42
43A set of :doc:`utilities <tools>` is also provided to {pre,post}process your data (:file:`./tools`).
44
45Project documentation
46=====================
47
48A walkthrough tutorial illustrates how to get code dependencies, compile and execute NEMO
49(:file:`./INSTALL.rst`).
50
51Reference manuals and quick start guide can be build from source and
52exported to HTML or PDF formats (:file:`./doc`) or
53downloaded directly from the :forge:`development platform<wiki/Documentations>`.
54
55============ ================== ===================
56 Component    Reference Manual   Quick Start Guide
57============ ================== ===================
58 |NEMO-OCE|   |DOI man OCE|_     |DOI strt gui|
59 |NEMO-ICE|   |DOI man ICE|
60 |NEMO-MBG|   |DOI man MBG|
61============ ================== ===================
62
63Since 2014 the project has a `Special Issue`_ in the open-access journal
64Geoscientific Model Development (GMD) from the European Geosciences Union (EGU_).
65The main scope is to collect relevant manuscripts covering various topics and
66to provide a single portal to assess the model potential and evolution.
67
68Used by a wide audience,
69numerous :website:`associated projects<projects>` have been carried out and
70extensive :website:`bibliography<bibliography/publications>` published.
71
72Development board
73=================
74
75The NEMO Consortium pulling together 5 European institutes
76(CMCC_, CNRS_, MOI_, `Met Office`_ and NERC_) plans the sustainable development in order to
77keep a reliable evolving framework since 2008.
78
79It defines the |DOI dev stgy|_ that is implemented by the System Team on a yearly basis
80in order to release a new version almost every four years.
81
82When the need arises, :forge:`working groups<wiki/WorkingGroups>` are created or resumed to
83gather the community expertise for advising on the development activities.
84
85.. |DOI dev stgy| replace:: multi-year development strategy
86
87Disclaimer
88==========
89
90The NEMO source code is freely available and distributed under
91:download:`CeCILL v2.0 license <../../../LICENSE>` (GNU GPL compatible).
92
93You can use, modify and/or redistribute the software under its terms,
94but users are provided only with a limited warranty and the software's authors and
95the successive licensor's have only limited liability.
Note: See TracBrowser for help on using the repository browser.