Skip to content
@neccton-algo

NECCTON algorithms

Algorithms developed in the NECCTON project

Description and guideline on the NECCTON-algo organization

neccton picture

What is the NECCTON-algo organization?

The NECCTON-algo organization hosts the algorithms developed in the framework of the NECCTON project.

Guideline for a repository in the organization

How to add a repository?

Requirements to add a repository to the organization https://github.com/neccton-algo:

  • Be a member of the NECCTON project
  • Put the mandatory files in the respository as described here.
  • Follow the recommendations as much as possible
  • Complete the table here :
Repository name Branch (default: main) Owner1 NECCTON task short description
Work Package 3
FABM @jornbr 3.* Framework for Aquatic Biogeochemical Models (FABM)
ERGOM-NECCTON Anja Lindenthal 3.2, 5.2.1, 5.2.3 and 5.2.4 ERGOM-FABM code with DVM and bio-optical modules
BAMHBI for FABM @Ezhen 3.2 FABM implementation of BAMHBI
SEAPODYM-1D-IET @cls-team 3.2 and 5.2.1 1D version of SEAPODYM-LMTL Intermediate Energy Transfert (IET)
PISCES for FABM @MoBelharet 3.2 FABM implementation of PISCES
Work Package 4
.github @brajard 4.1 description of the github organization
MuSt3Net @TeresaTonelli 4.2.1 Multiple Steps 3D Convolutional Neural Network for data integration (or model data fusion)
EmuPML @JOZSKA 4.2.2 Predict carbon pools from observable variables for North-West European Shelf
DINCAE-benthic-traits @Alexander-Barth,@AbelDechN 4.2.2 Interpolation data products of benthic traits
Hg_SOM @Marco-Puglia 4.2.2 Interpolation Self-Organizing Map for Mercury Distribution
 NO3 Emulator @dsbanerjee90 4.2.3 ML-derived Surface Nitrate Bias Correction for the Northwest European Shelf
PNMI data paper @dlaetitia 4.3.1 Spatial distribution of zooplankton diversity in the Parc Naturel Marin Iroise (PNMI)
NECCTON_PNMI_ML @dlaetitia 4.3.1 ML algorithms to study the spatial distribution of plankton diversity in the Parc Naturel Marin Iroise (PNMI)
DVM @caglartac 4.3.2 Diel vertical migration parameter estimation using acoustics backscatter data
CODA    @dgreenberg 4.3.3 Combined Optimization of Dynamics and Assimilation with End-to-End Learning on Sparse Observations
Neccton_Super_Resolution @AntoineBernigaud 4.4.3 Super Resolution Data Assimilation
DIIM @CarlosSoto 4.4.2 Python tool for the estimation of marine optical constituents from Remote Sensing Reflectance
NEMOVAR Rrs DA    @JOZSKA 4.4.2  Fortran scripts to be embedded within NEMOVAR-related balancing scheme to assimilate spectral Rrs
SORDA @verezem 4.4.2 Assimilation of new type of data, Spectral Ocean Reflectance Data Assimilation
Work Package 5
ERSEM-NECCTON dvm @r-millington 5.2.1 DVM Model in ERSEM
ECOSMO @caglartac 4.3.1 and 5.2.1 main ECOSMO and diel vertical migration codes
ERSEM-NECCTON spm @jimc101 5.2.2 SPM Model in ERSEM
SPMmodule @giubonino 5.2.2 SPM module
bamhbi-spm @mchoblet 5.2.2 Bamhbi benthic model (Organic SPM)
BFMFORFABM @plazzari 5.2.3 and 5.2.4 POC and bio-optic module used within BFM
ERSEM-NECCTON DOC @hpowley 5.2.3 NECCTON DOC changes in ERSEM
ERSEM-NECCTON CDOM @hpowley 5.2.4 CDOM additions for bio-optical model in ERSEM
fabm-spectral rrs @hpowley 5.2.4 Bio-optical model used with ERSEM
bamhbi-rt @loic-mace 5.2.4 Bio-optics module for BAMHBI
ECOSMO-MERCYE @jbieser 5.2.5 Marine POP Cycling module

| Work Package 6| | Benthic-Habitat-Models | | @damianobaldan | 6.2.2 | Benthic habitat mapping markdown | | ERSEM-NECCTON | benthic-fauna | @r-millington | 5.2.1 | Benthic predators added to ERSEM for NECCTON| | Benthic_Process_models | | @QMudde | 6.2.4 | Process models for keystone benthic species | | Work Package 7&8| | FEISTY | | @KenHasteAndersen | 7.3 | Fortran and R implementation of the FEISTY fish community model | | OGSTM-BFM-Hg | neccton_WP8|@ginRosati|8.2| Marine biogeochemical mercury model| | plasticparcels | | @michaeldenes | 8.2.1 | Microplastic transport and dispersion simulation tool based on the parcels Lagrangian framework | | Plastic_Poseidon | | @tamvas3712 | 8.2.2 | Marine plastic pollution module | | MEDSLIK_II_NECCTON | | @SLiubartseva | 8.2.3 | MEDSLIK-II code for NECCTON project | | CanMETOP | | Zhiyong Xie | 8.2.5 | POPs’ Global atmospheric transport model | | ECOSMO-MERCY | | @jbieser | 8.2.5 | Marine Mercury Cycling and Bioaccumulation module | | Bfiat | | @karlines | 8.2.6 | Bottom Fishing Impact Assessment Tools | | CC Indices | | @ledm | 8.4 | Climate Change Stressor Indices |

Content of a repository

A GitHub repository of the NECCTON GitHub organization contains the following file:

  • A LICENCE file: NECCTON encourages the use of open-source licences.
  • A CODEOWNERSfile: indicate the main contacts for the repository. See here for more details.
  • A README file: see the minimum requirement for the README file here
  • One or several Jupyter notebooks to demonstrate the algorithm and the baseline. The baseline corresponds to an existing algorithm or a minimal solution (e.g. linear regression) that the algorithm is expected to outperform.

README

The README file must contain a description for:

  • the data source
  • the baseline (or a link to the jupyter notebook of the baseline)
  • the metrics used to validate the output(s) of the algorithm
  • the list of dependencies (name of the dependency and full version number used) needed to use the code, and use language-specific tools to install the dependencies (recommended)
  • the documentation (e.g., via a link). It should allow a potential user to understand the code and reuse it. The documentation will be available at the M36 of the NECCTON project.
  • Citations and links for NECCTON publications using or introducing the code, when applicable.

Recommendations

In addition to the points mentionned above, it is strongly suggested to:

  • Use a data API for easy access to the data when testing the code
  • Make use of GitHub actions to run unit tests when pushing the code on the repository (or when merging with the main branch). See here for a documentation of GitHub actions.
  • Use language specific tools (e.g. conda, pipenv) to define the running environment.
  • Use the latest best coding practices. For more details, see here
  • Upload code to the organization code that is specific to the NECCTON project. Other generic tools can be hosted elsewhere.

Footnotes

  1. indicate here the github login of the main contact for the code.

Popular repositories Loading

  1. .github .github Public

    Description and guideline on the NECCTON-algo organization

    3 10

  2. Neccton_Super_Resolution Neccton_Super_Resolution Public

    Forked from AntoineBernigaud/Neccton_Super_Resolution

    Super Resolution for the NECCTON project

    Jupyter Notebook 1

  3. DINCAE-benthic-traits DINCAE-benthic-traits Public

    Neural network to generate maps of benthic traits

    Jupyter Notebook 1

  4. demo-github-action demo-github-action Public

    Predict satellite data based on L3 data (including missing data) with a UNet

    Python 1

  5. SORDA SORDA Public

    Spectral Ocean Reflectance Data EnKF-based Assimilation

    Jupyter Notebook 1

  6. NO3_Emulator_NECCTON NO3_Emulator_NECCTON Public

    This repository contains the setting up of a Neural Network Model trained with atmosphere, ocean biogegeochemical, ocean physical inputs that predicts nitrate concentration across the North West Eu…

    Python

Repositories

Showing 10 of 10 repositories

Top languages

Loading…

Most used topics

Loading…