source: NEMO/trunk/README.rst @ 11708

Last change on this file since 11708 was 11708, checked in by nicolasmartin, 15 months ago

z

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