Skip to content
Snippets Groups Projects
README.rst 5.2 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!
==========================

Guillaume Samson's avatar
Guillaume Samson committed
NEMO_ for *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,
Claire Levy's avatar
Claire Levy committed
developed in a sustainable way by the NEMO European consortium since 2008.
NEMO has 3 major components:
Guillaume Samson's avatar
Guillaume Samson committed

Claire Levy's avatar
Claire Levy committed
This page intends to help to get started using NEMO platform and to orientate users to the different levels of information. 
It starts here with NEMO release 4.2.0. [Former web platform forge](https://forge.ipsl.jussieu.fr/nemo) (SVN+Trac) contains previous documentation and releases since the beginning of the project up to of NEMO 4.0.
Claire Levy's avatar
Claire Levy committed
If you are already using NEMO with a previous release, refer to the Migration Guide to help making the move to 4.2.0.
Guillaume Samson's avatar
Guillaume Samson committed

Claire Levy's avatar
Claire Levy committed
Getting started
===============
Getting hands on NEMO: first steps are described in detail in the "How to" NEMO users's guide
Download, build the environment create the executable, and make a first run are described here: https://sites.nemo-ocean.io/user_guide/
Guillaume Samson's avatar
Guillaume Samson committed

Claire Levy's avatar
Claire Levy committed
A summary on  how to get code dependencies, compile and execute NEMO is also available here
(:file:`./INSTALL.rst`).
Guillaume Samson's avatar
Guillaume Samson committed

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   
============ ================== 
Claire Levy's avatar
Claire Levy committed
 |NEMO-OCE|   |https://zenodo.org/record/1464816|    
 |NEMO-ICE|   |https://zenodo.org/record/1471689|
 |NEMO-MBG|   |https://zenodo.org/record/1471700|
Claire Levy's avatar
Claire Levy committed
============ ================== 
Claire Levy's avatar
Claire Levy committed

These reference manuals are the publications that should be cited in your own publications.

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

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.
- [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
-  Adding your publications using NEMO and its outputs here: https://www.nemo-ocean.eu/bibliography/publications/add
-  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.


More on NEMO's features
=======================
Guillaume Samson's avatar
Guillaume Samson committed
Not only does the NEMO framework model the ocean circulation,
it offers various features to enable

- Create :doc:`embedded zooms<zooms>` seamlessly thanks to 2-way nesting package AGRIF_.
- Opportunity to integrate an :doc:`external biogeochemistry model<tracers>`
- Versatile :doc:`data assimilation<da>`
- Generation of :doc:`diagnostics<diags>` through effective XIOS_ system
- Roll-out Earth system modeling with :doc:`coupling interface<cplg>` based on OASIS_

Several :doc:`built-in configurations<cfgs>` are provided to
evaluate the skills and performances of the model which
can be used as templates for setting up a new configurations (:file:`./cfgs`).

The user can also checkout available :doc:`idealized test cases<tests>` that
address specific physical processes (:file:`./tests`).

A set of :doc:`utilities <tools>` is also provided to {pre,post}process your data (:file:`./tools`).

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.