Skip to content
Snippets Groups Projects
README.rst 5.29 KiB
Newer Older
Guillaume Samson's avatar
Guillaume Samson committed
.. todo::
Claire Levy's avatar
Claire Levy committed
.. contents::
   :local:


Claire Levy's avatar
Claire Levy committed
Welcome to NEMO home page!
==========================

Claire Levy's avatar
Claire Levy committed
NEMO (*Nucleus for European Modelling of the Ocean*) is a state-of-the-art modelling framework for research activities and forecasting services in ocean and climate sciences, developed in a sustainable way by the NEMO European consortium since 2008.
Guillaume Samson's avatar
Guillaume Samson committed

Claire Levy's avatar
Claire Levy committed
This page intends to help you to get started using the NEMO platform and to introduce you to the different levels of information available. It starts here with NEMO release 4.2.0.
Claire Levy's avatar
Claire Levy committed

Claire Levy's avatar
Claire Levy committed
Reminder: [Former web platform forge](https://forge.ipsl.jussieu.fr/nemo) (SVN+Trac) contains the previous documentation and releases made available from the beginning of the project up to of NEMO 4.0.
Guillaume Samson's avatar
Guillaume Samson committed

Claire Levy's avatar
Claire Levy committed
Getting started
===============
Claire Levy's avatar
Claire Levy committed
Getting your hands on NEMO: the first steps are described in detail in the NEMO users' guide: https://sites.nemo-ocean.io/user-guide/. This explains how to download the code, build the environment, create the executable, and perform a first integration.
Claire Levy's avatar
Claire Levy committed

Claire Levy's avatar
Claire Levy committed
If you are already using a previous release of NEMO, please refer to the [Migration Guide] (https://sites.nemo-ocean.io/user-guide/migration.html) which aims to help you to make the move to 4.2.0.
Claire Levy's avatar
Claire Levy committed

Claire Levy's avatar
Claire Levy committed
The above users guides cover in detail what is available from gitlab and supported by NEMO System Team. Aside from this web platform, a set of test cases is also available from https://github.com/NEMO-ocean/NEMO-examples. These test cases can be useful for students, outreach, and exploring specific aspects of NEMO with light configurations. The web page also allows you to submit test cases you have developed and want to share with the community. Feel free to contribute!
Claire Levy's avatar
Claire Levy committed
Project documentation
=====================

Reference manuals fully describing NEMO  for the three main component
Claire Levy's avatar
Claire Levy committed

* |OCE| models the ocean {thermo}dynamics and solves the primitive equations (:file:`./src/OCE`)

* |ICE| simulates sea-ice {thermo}dynamics, brine inclusions and  subgrid-scale thickness variations (:file:`./src/ICE`)

* |MBG| models the {on,off}line oceanic tracers transport and biogeochemical processes  (:file:`./src/TOP`)
Claire Levy's avatar
Claire Levy committed
are available from zenodo

Claire Levy's avatar
Claire Levy committed
============ ==============================================   =============================================== 
 Component    Reference Manual (from zenondo, DOI to quote)   Reference manual (pdf on line version on gitlab)  
============ ==============================================   ===============================================  
Claire Levy's avatar
Claire Levy committed
 |NEMO-OCE|   |https://zenodo.org/record/1464816|                 Final link to add 
 |NEMO-ICE|   |https://zenodo.org/record/1471689|             *Updated version will be online in  March 2022*
 |NEMO-MBG|   |https://zenodo.org/record/1471700|             *Updated version will be online in March 2022*
Claire Levy's avatar
Claire Levy committed
============ ==============================================   ===============================================  
Claire Levy's avatar
Claire Levy committed

Stefania Ciliberti's avatar
Stefania Ciliberti committed
These reference manuals are the publications that should be cited in your own publications. Please visit [How to cite?](https://www.nemo-ocean.eu/bibliography/how-to-cite/) for details.
Claire Levy's avatar
Claire Levy committed

New features of 4.2.0 release are described here (:file:`./CHANGES.md`)

Claire Levy's avatar
Claire Levy committed

Claire Levy's avatar
Claire Levy committed
Asking questions, echange information
=====================================
- [Register once for all and use the NEMO forums](https://nemo-ocean.discourse.group) to share and discuss with the NEMO community.
Claire Levy's avatar
Claire Levy committed

Claire Levy's avatar
Claire Levy committed
- [Register once for all and receive by mail the NEMO newsletter ](https://listes.ipsl.fr/sympa/subscribe/nemo-newsletter) : recommended for all users to receive the major announcements from the project (new releases, open meetings and main informations). Low traffic: about ten messages a year.
Claire Levy's avatar
Claire Levy committed
Contributing to NEMO visibility: projects and publications
==========================================================
Please help us justifying the NEMO development efforts by
Claire Levy's avatar
Claire Levy committed

Claire Levy's avatar
Claire Levy committed
-  Adding your publications using NEMO and its outputs here: https://www.nemo-ocean.eu/bibliography/publications/add
Claire Levy's avatar
Claire Levy committed

Claire Levy's avatar
Claire Levy committed
-  Describing your project using NEMO here: https://www.nemo-ocean.eu/projects/add

NEMO also has a `Special Issue`_ in the open-access journal
Geoscientific Model Development (GMD) from the European Geosciences Union (https://gmd.copernicus.org/articles/special_issue40.html).
Claire Levy's avatar
Claire Levy committed
The main scope is to collect relevant manuscripts covering various topics and
to provide a single portal to assess the model potential and evolution.


Guillaume Samson's avatar
Guillaume Samson committed

Claire Levy's avatar
Claire Levy committed
Contributing to NEMO development
================================
Guillaume Samson's avatar
Guillaume Samson committed

Claire Levy's avatar
Claire Levy committed
NEMO intends to be written in a way allowing easy plug of developments.
You are also welcome to contribute to the development of the NEMO Shared reference.
NEMO development is driven by  NEMO Consortium planning and producing NEMO's sustainable development in order to
keep a reliable evolving framework.
Development is organised and scheduled through a five years development strategy, Working groups and the activities of the development team (named NEMO System Team) in a yearly workplan. [More information here] (https://forge.nemo-ocean.eu/developers/home/-/wikis/Home)
Guillaume Samson's avatar
Guillaume Samson committed


Disclaimer
==========

The NEMO source code is freely available and distributed under
:download:`CeCILL v2.0 license <../../../LICENSE>` (GNU GPL compatible).

You can use, modify and/or redistribute the software under its terms,
but users are provided only with a limited warranty and the software's authors and
the successive licensor's have only limited liability.