Data

Tools

Indexes

Applications

Experiments

Open Source Science

xtclim

https://github.com/intertwin-eu/xtclim

Science Score: 26.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (11.2%) to scientific vocabulary
Last synced: 10 months ago · JSON representation

Repository

Basic Info
  • Host: GitHub
  • Owner: interTwin-eu
  • License: apache-2.0
  • Language: Jupyter Notebook
  • Default Branch: main
  • Size: 2.13 MB
Statistics
  • Stars: 0
  • Watchers: 3
  • Forks: 2
  • Open Issues: 1
  • Releases: 3
Created over 1 year ago · Last pushed 11 months ago
Metadata Files
Readme Changelog Contributing License Code of conduct Codeowners Authors Codemeta

README.md

xtclim

ML-based extreme events detection and characterization (CERFACS)

The code is adapted from CERFACS' repository. The implementation of a pipeline with itwinai framework is shown below.

Method

Convolutional Variational AutoEncoder.

Input

"3D daily images", daily screenshots of Europe for three climate variables (maximum temperature, precipitation, wind).

Output

Error between original and reconstructed image: postprocessed for analysis in the presentation_notebook.ipynb file.

Idea

The more unusual an image (anomaly), the higher error.

Information on files

In the preprocessing folder, the preprocess_functions_2d_ssp.py class loads NetCDF files from a data folder, which has to be specified in dataset_root in the config file config.yaml (please change the location). The given class normalizes,and adjusts the data for the network. The function preprocess_2d_seasons.py splits the data into seasonal files. Preprocessed data is stored in the input folder.

The file train.py trains the network. Caution: It will overwrite the weights of the network already saved in outputs (unless you change the path name outputs/cvae_model_3d.pth in the script). This file also contains the inference script that evaluates the network on the available datasets - train, test, and projection.

How to launch training workflow

The config file config.yaml contains all the steps to execute the workflow. You can launch it from the root of the repository with:

bash itwinai exec-pipeline --config-name config.yaml

[!NOTE] To help debugging errors, prepend HYDRA_FULL_ERROR=1 to your command, or set it as an evironment variable with export HYDRA_FULL_ERROR=1. Example:

bash HYDRA_FULL_ERROR=1 itwinai exec-pipeline --config-name config.yaml

To dynamically override some (nested) fields from terminal you can do:

bash itwinai exec-pipeline --config-name config.yaml \ GENERAL.dataset_root=/path/to/data \ GENERAL.input_path=input \ GENERAL.output_path=output

To run only some steps, e.g., only training step after the training dataset has been generated, use:

bash itwinai exec-pipeline --config-name config.yaml +pipe_steps=[training-step]

TODOs

Integration of post-processing step + distributed strategies

Owner

  • Name: interTwin Community
  • Login: interTwin-eu
  • Kind: organization
  • Email: info@intertwin.eu

Co-designing and prototyping an interdisciplinary Digital Twin Engine.

CodeMeta (codemeta.json) 

{
  "@context": "https://doi.org/10.5063/schema/codemeta-2.0",
  "@type": "SoftwareSourceCode",
  "name": "itwinai-xtclim-plugin",
  "description": "xtclim plugin for itwinai",
  "version": "0.1.0",
  "codeRepository": "https://github.com/interTwin-eu/itwinai",
  "license": "MIT",
  "programmingLanguage": "Python",
  "developmentStatus": "active",
  "dateCreated": "2025-05-21",
  "dateModified": "2025-05-21",
  "author": [
    {
      "@type": "Person",
      "givenName": "Christian",
      "familyName": "Page",
      "email": "christian.page@cerfacs.fr"
    },
    {
      "@type": "Person",
      "givenName": "Matteo",
      "familyName": "Bunino",
      "email": "matteo.bunino@cern.ch"
    }
  ],
  "identifier": "doi:10.xxxx/zenodo.xxxxxxx"
}

GitHub Events

Total
  • Release event: 3
  • Delete event: 1
  • Issue comment event: 4
  • Member event: 1
  • Push event: 51
  • Pull request review event: 2
  • Pull request event: 13
  • Fork event: 1
  • Create event: 8
Last Year
  • Release event: 3
  • Delete event: 1
  • Issue comment event: 4
  • Member event: 1
  • Push event: 51
  • Pull request review event: 2
  • Pull request event: 13
  • Fork event: 1
  • Create event: 8

Issues and Pull Requests

Last synced: 10 months ago

All Time
  • Total issues: 0
  • Total pull requests: 7
  • Average time to close issues: N/A
  • Average time to close pull requests: 9 days
  • Total issue authors: 0
  • Total pull request authors: 4
  • Average comments per issue: 0
  • Average comments per pull request: 0.0
  • Merged pull requests: 3
  • Bot issues: 0
  • Bot pull requests: 1
Past Year
  • Issues: 0
  • Pull requests: 7
  • Average time to close issues: N/A
  • Average time to close pull requests: 9 days
  • Issue authors: 0
  • Pull request authors: 4
  • Average comments per issue: 0
  • Average comments per pull request: 0.0
  • Merged pull requests: 3
  • Bot issues: 0
  • Bot pull requests: 1
View more stats
Top Authors
Issue Authors
Pull Request Authors
  • matbun (4)
  • clemoule (1)
  • dependabot[bot] (1)
  • pagecp (1)
Top Labels
Issue Labels
Pull Request Labels
dependencies (1) github_actions (1)

Dependencies

.github/workflows/check-links.yml actions
  • actions/checkout v4 composite
  • gaurav-nelson/github-action-markdown-link-check v1 composite
.github/workflows/lint.yml actions
  • actions/checkout v4 composite
  • docker://ghcr.io/github/super-linter slim-v4 composite
pyproject.toml pypi
  • itwinai *