Skip to content

CIA-Oceanix/4dvarnet-turbiditymapping

Repository files navigation

How to use the 4DVarNet scheme for turbidity mapping


Abstract

The purpose of the 4DVarNet scheme for turbidity mapping is to reconstruct and map gappy, noisy satellite observations to obtain gap-free, less noisy reconstructions using a pretrained 4DVarNet model, as shown in the image below: 4dVarNet Workflow

Papers and references to understand the 4DVarNet scheme can be found at https://drive.google.com/drive/folders/1O2MLvO-UpKn7cAIBaDHLYhT81NlE1py-?usp=sharing

The main 4Dvarnet project can be found at https://github.com/CIA-Oceanix/4dvarnet-starter

The code of the 4DVarNet scheme for turbidity mapping can be found at https://github.com/nguyenthuynga/4dvarnet-starter


Tutorial

A tutorial focuses on applying the 4DVarNet for sea surface turbidity mapping in the Wadden Sea.

You will learn how to run the inference phase using a pre-trained 4DVarNet model and then compare the results with other existing state-of-the-art turbidity mappings.

The Jupyter notebook, turbidity_output_analysis.ipynb, explains the purpose of each cell at the beginning.

It runs 4DVArNet Predictions to Perform Machine Learning-Based Interpolation on Gappy Satellite Observations with 4DVarNet.

And returns a comparison of different mapping schemes: 4DVarNet, DInEOF, and eDInEOF.

This tutorial use data which are already preprocessing (by taking log10 values), to quick run the code without changing too many things.

Theses datas are downloaded from "Wasabi Storage" within the notebook, and are also available in this Drive folder : https://drive.google.com/drive/folders/1JwX9sn6gm2-RgEJ10Pxw5dh_S8h-dyaV?usp=sharing.

To get more informations about tutorial configuration and dataset, or if you want to use other dataset, or other parameters, follow the Use custom dataset documentation.


Tutorial Technical environment

This tutorial use an environment with Pytorch lightning, and Hydra.

The easyest way of running this tutorial, it to use the EDITO Datalab Platform :

  1. Go to the Ocean Modelling catalog
  2. Search and launch the turbiditymapping-4dvarNet service.

But the environment can also be installed your laptop or serveur, following the Install environment documentation.

If you are using Docker or Singularity/Apptainer, you can use the inseefrlab/onyxia-jupyter-pytorch:py3.11.10-gpu image.


How to use the tutorial

  1. Run Jupyter Notebook turbidity_output_analysis.ipynb :

    • It first downloads the datas : the OSE CMEMS data + pretrained 4DVarNet weight
    • Then runs the main script, which generate output inside the outputs folder.
    • And runs python code to get the analysis, visualisation of 4DVarNet compared with two other existing data driven algorithms (DInEOF and eDInEOF).
  2. After this steps, you’ll be able to get the metrics (RMSE-Root Mean Square Error and RE-Relative Error) and the visualisation. as below.

metrics

visualization


Other informations


Useful links

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.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published