1 | .. todo:: |
---|
2 | |
---|
3 | |
---|
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, |
---|
7 | developed in a sustainable way by a European consortium since 2008. |
---|
8 | |
---|
9 | .. contents:: |
---|
10 | :local: |
---|
11 | |
---|
12 | Overview |
---|
13 | ======== |
---|
14 | |
---|
15 | The NEMO ocean model has 3 major components: |
---|
16 | |
---|
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`) |
---|
23 | |
---|
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`). |
---|
27 | |
---|
28 | Assets and solutions |
---|
29 | ==================== |
---|
30 | |
---|
31 | Not only does the NEMO framework model the ocean circulation, |
---|
32 | it offers various features to enable |
---|
33 | |
---|
34 | - Create :doc:`embedded zooms<zooms>` seamlessly thanks to 2-way nesting package AGRIF_. |
---|
35 | - Opportunity to integrate an :doc:`external biogeochemistry model<tracers>` |
---|
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_ |
---|
39 | |
---|
40 | Several :doc:`built-in configurations<cfgs>` are provided to |
---|
41 | evaluate the skills and performances of the model which |
---|
42 | can be used as templates for setting up a new configurations (:file:`./cfgs`). |
---|
43 | |
---|
44 | The user can also checkout available :doc:`idealized test cases<tests>` that |
---|
45 | address specific physical processes (:file:`./tests`). |
---|
46 | |
---|
47 | A set of :doc:`utilities <tools>` is also provided to {pre,post}process your data (:file:`./tools`). |
---|
48 | |
---|
49 | Project documentation |
---|
50 | ===================== |
---|
51 | |
---|
52 | A walkthrough tutorial illustrates how to get code dependencies, compile and execute NEMO |
---|
53 | (:file:`./INSTALL.rst`). |
---|
54 | |
---|
55 | Reference manuals and quick start guide can be build from source and |
---|
56 | exported to HTML or PDF formats (:file:`./doc`) or |
---|
57 | downloaded directly from the :forge:`development platform<wiki/Documentations>`. |
---|
58 | |
---|
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-TOP| |DOI man TOP| |
---|
65 | ============ ================== =================== |
---|
66 | |
---|
67 | Since 2014 the project has a `Special Issue`_ in the open-access journal |
---|
68 | Geoscientific Model Development (GMD) from the European Geosciences Union (EGU_). |
---|
69 | The main scope is to collect relevant manuscripts covering various topics and |
---|
70 | to provide a single portal to assess the model potential and evolution. |
---|
71 | |
---|
72 | Used by a wide audience, |
---|
73 | numerous :website:`associated projects<projects>` have been carried out and |
---|
74 | extensive :website:`bibliography<bibliography/publications>` published. |
---|
75 | |
---|
76 | Development board |
---|
77 | ================= |
---|
78 | |
---|
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 | |
---|
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 | |
---|
86 | When the need arises, :forge:`working groups<wiki/WorkingGroups>` are created or resumed to |
---|
87 | gather the community expertise for advising on the development activities. |
---|
88 | |
---|
89 | .. |DOI dev stgy| replace:: multi-year development strategy |
---|
90 | |
---|
91 | Disclaimer |
---|
92 | ========== |
---|
93 | |
---|
94 | The NEMO source code is freely available and distributed under |
---|
95 | :download:`CeCILL v2.0 license <../../../LICENSE>` (GNU GPL compatible). |
---|
96 | |
---|
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. |
---|