Skip to content

Welcome to ocean4DVarNet documentation!

DOI

About ocean4DVarNet

4DVarNet (short for 4D-Variational Network) is a deep learning-based framework that combines ideas from data assimilation (specifically 4D-Var) with neural networks to reconstruct high-resolution spatiotemporal data from incomplete and noisy observations, commonly applied in Earth sciences like oceanography and meteorology.

Get more informations about Ocean4DVarnet Concepts.

Installing

To install the package, you can use the following command: 

pip install ocean4dvarnet

Get more information in the installing section

Usage

import ocean4dvarnet

Project getting started : https://github.com/CIA-Oceanix/4dvarnet-starter

Ocean4DVarnet Extension

This package contains the model's main functions.

Another package is available, containing extended functionality : models, dataloader, etc. ... : Ocean4DVarnet-contrib : https://github.com/CIA-Oceanix/ocean4dvarnet-contrib

Contributing

If you want to add specific models, data loaders, utilities, etc., the best way to do so is to contribute to the Ocean4DVarnet-contrib project.

If you want to contribute to the core Ocean4DVarnet Package, please follow the informations in the contributing section.

License

Copyright IMT Atlantique/OceaniX, contributor(s) : M. Beauchamp, R. Fablet, Q. Febvre, D. Zhu (IMT Atlantique)

Contact person: ronan.fablet@imt-atlantique.fr.

This software is a computer program whose purpose is to apply deep learning schemes to dynamical systems and ocean remote sensing data.

This software is governed by the CeCILL-C license under French law and abiding by the rules of distribution of free software.

You can use, modify and/ or redistribute the software under the terms of the CeCILL-C license as circulated by CEA, CNRS and INRIA at the following URL "http://www.cecill.info". As a counterpart to the access to the source code and rights to copy, modify and redistribute granted by the license, users are provided only with a limited warranty and the software's author, the holder of the economic rights, and the successive licensors have only limited liability.

In this respect, the user's attention is drawn to the risks associated with loading, using, modifying and/or developing or reproducing the software by the user in light of its specific status of free software, that may mean that it is complicated to manipulate, and that also therefore means that it is reserved for developers and experienced professionals having in-depth computer knowledge. Users are therefore encouraged to load and test the software's suitability as regards their requirements in conditions enabling the security of their systems and/or data to be ensured and, more generally, to use and operate it in the same conditions as regards security. The fact that you are presently reading this means that you have had knowledge of the CeCILL-C license and that you accept its terms.