Skip to main content

Provides a reproducible, versioned Python environment for Anemoi experiments.

Project description

Project Maturity: Emerging CI Test Status CI Publish Status

Provides a reproducible, versioned Python environment for Anemoi experiments.

anemoi-env is a meta-package that defines a standardized set of dependencies for machine learning and data science workflows. It contains no source code—only dependency declarations that are automatically versioned and published monthly.

Installation

Stable Release (Locked Dependencies)

For reproducible environments, install a specific calendar-versioned release from PyPI:

$ pip install anemoi-env==2026.2.0

Or install the latest locked version from the main branch:

$ pip install git+https://github.com/MeteoSwiss/anemoi-env.git@main

Development (Flexible Dependencies)

For development with the latest Anemoi features from main branches (no lock file):

$ pip install git+https://github.com/MeteoSwiss/anemoi-env.git@dev

Warning: The dev branch uses bleeding-edge dependencies and may be unstable.

Feature Testing (Fixed Commit SHAs)

For testing specific features with reproducible Anemoi commits, create a feature branch from main (not dev):

$ git checkout main
$ git checkout -b feature-test/new-graphs

Then edit pyproject.toml to pin specific commits:

[tool.poetry.dependencies]
anemoi-datasets = { git = "https://github.com/ecmwf/anemoi-datasets", rev = "abc123def" }
anemoi-graphs = { git = "https://github.com/ecmwf/anemoi-core.git", subdirectory = "graphs", rev = "def456abc" }
# ... other packages with fixed revisions

Run poetry lock to generate a lock file for this specific combination, then install:

$ poetry lock
$ poetry install

This approach provides reproducibility while testing bleeding-edge features before they’re released to PyPI.

Advanced Installation

CUDA-Specific PyTorch Versions

By default, anemoi-env installs PyTorch with CPU support or CUDA support based on what’s available in the default PyPI index. To install a specific CUDA version (e.g., CUDA 12.1), use PyTorch’s extra index URL:

$ pip install anemoi-env==2026.2.0 --extra-index-url https://download.pytorch.org/whl/cu121
$ pip install anemoi-env==2026.2.0 --extra-index-url https://download.pytorch.org/whl/cpu

Installing Anemoi Package Extras

Some Anemoi packages provide optional features via extras (e.g., anemoi-graphs[tri] for trimesh support). To use these extras while respecting the tested dependency versions from anemoi-env:

$ pip install anemoi-env==2026.2.0
$ pip install "anemoi-graphs[tri]"

Why install in two steps?

  • Installing anemoi-env first locks all core Anemoi packages to tested, compatible versions

  • Installing the extra second (e.g., [tri]) adds optional dependencies (like trimesh) with version constraints that are compatible with the already-installed anemoi-graphs

  • If you directly pip install trimesh without the extra, you might get an incompatible version that hasn’t been tested with Anemoi

Always check each Anemoi package’s documentation for available extras.

Branching Strategy

This repository uses a multi-branch strategy with different dependency sources:

  • main: Contains poetry.lock and uses stable PyPI releases of all dependencies. Updated automatically on the 1st of every month via CI. Each update creates a calendar-versioned release (e.g., 2025.10.0) and publishes to PyPI. Use this for reproducible, production-ready environments.

  • dev: Contains pyproject.toml with no lock file and uses bleeding-edge versions from Anemoi package main branches (via git dependencies). Used for development against the latest Anemoi features. Not published to PyPI.

  • feature-test/: Custom feature branches with fixed commit SHAs for each Anemoi package. Includes poetry.lock for reproducible testing of specific feature combinations. Useful for validating new features before they reach PyPI. Not published.

Continuous Integration

The repository includes automated CI/CD workflows:

  • CI Test (CI_test.yaml): Runs on every push and pull request. Tests installation and verifies that all Anemoi packages can be imported successfully.

  • CI Publish (CI_publish.yaml): Runs on the 1st of every month at 3 AM UTC. Automatically:

    1. Updates poetry.lock with latest compatible versions

    2. Updates version to current date (YYYY.MM.patch)

    3. Updates Changelogs with the new release information

    4. Creates a git tag

    5. Publishes the new release to PyPI

This ensures monthly snapshots of the Anemoi ecosystem are automatically published when updates are available.

Versioning

Uses Calendar Versioning (CalVer): YYYY.MM.patch

Each monthly release represents a snapshot of the dependency tree at that point in time. The patch number increments for additional releases within the same month (e.g., 2025.10.0, 2025.10.1, 2025.11.0).

What’s Included

  • Anemoi Packages:

    • anemoi-datasets

    • anemoi-graphs

    • anemoi-inference

    • anemoi-models

    • anemoi-registry

    • anemoi-training

    • anemoi-utils

Development Setup with Poetry

Note: This package is a meta-package with no source code. Development primarily involves updating dependencies in pyproject.toml.

Local Development

Clone and install in development mode:

$ git clone https://github.com/MeteoSwiss/anemoi-env.git
$ cd anemoi-env
$ git checkout dev
$ poetry install

Generate Documentation

$ poetry run sphinx-build doc doc/_build

Then open the index.html file generated in anemoi-env/doc/_build/.

Usage For Reproducible Research

Always specify the exact version in your project dependencies:

For stable PyPI releases:

In pyproject.toml:

[tool.poetry.dependencies]
anemoi-env = "2026.2.0"

Or in requirements.txt:

anemoi-env==2026.2.0

For testing specific feature combinations:

[tool.poetry.dependencies]
anemoi-env = { git = "https://github.com/MeteoSwiss/anemoi-env.git", rev = "feature-test/new-graphs" }

This ensures your research uses a specific, reproducible set of dependencies—either from PyPI (stable) or from a pinned feature branch (testing).

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

anemoi_env-2026.2.0.tar.gz (5.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

anemoi_env-2026.2.0-py3-none-any.whl (5.1 kB view details)

Uploaded Python 3

File details

Details for the file anemoi_env-2026.2.0.tar.gz.

File metadata

  • Download URL: anemoi_env-2026.2.0.tar.gz
  • Upload date:
  • Size: 5.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.3.1 CPython/3.12.12 Linux/6.11.0-1018-azure

File hashes

Hashes for anemoi_env-2026.2.0.tar.gz
Algorithm Hash digest
SHA256 9dfe657ea095c40263167c25d07d043841e5905542dab0a445334f6ec6c7be1c
MD5 5867cbd63e8b1343f88a5f43d4178378
BLAKE2b-256 e66337c5196ecffa9a07c5449ca40e88dbfcc255a8face0af3593c3b0eda35db

See more details on using hashes here.

File details

Details for the file anemoi_env-2026.2.0-py3-none-any.whl.

File metadata

  • Download URL: anemoi_env-2026.2.0-py3-none-any.whl
  • Upload date:
  • Size: 5.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.3.1 CPython/3.12.12 Linux/6.11.0-1018-azure

File hashes

Hashes for anemoi_env-2026.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 48be86ebfff4dbdd7978230d799182c2f00b5cf26502efc310397bb734875085
MD5 d92a6b3f0de713984e673e9bf20db31b
BLAKE2b-256 2172bc0c0d4e31f3153179f2d995bfa876c9003038ed4acbbcbe05c2e0bd2ca5

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page