Skip to main content

Score-based generative emulation of impact-relevant earth system model outputs

Project description

image image

ESM Emulation with diffusion models in JAX

Codebase allows to run emulators of monthly averaged near-surface temperature, precipitation, relative humidity, wind speed for MPI-ESM1-2-LR, MIROC6, ACCESS-ESM1-5.

Installation

Code tested on Python ≥3.11. GPU support is required for practical usage. Install from PyPI:

|-----------------|----------------------------------------------------------------------------------------------------------------| | CPU | pip install climemu | | NVIDIA GPU | pip install climemu[cuda12] | | Google TPU | pip install climemu[tpu] |

Usage

import climemu

# Instantiate emulator
emulator = climemu.build_emulator("MPI-ESM1-2-LR")

# Download pretrained weights and compile (~1min)
emulator.load()
emulator.compile(n_samples=5)   # Nb of samples generated at each function call

# Generate 5 samples for a given gmst and month
samples = emulator(gmst=2,       # GMST anomaly wrt piControl (°C)
                   month=3,      # Month index (1-12)
                   seed=0,       # Random seed
                   xarray=True)  # Return xr.Dataset

:warning: Default model files for usage are trained on the full set of Tier I SSP simulations. To reproduce the paper results follow instructions.

Citing

add

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

climemu-0.1.9.tar.gz (29.8 kB view details)

Uploaded Source

Built Distribution

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

climemu-0.1.9-py3-none-any.whl (36.4 kB view details)

Uploaded Python 3

File details

Details for the file climemu-0.1.9.tar.gz.

File metadata

  • Download URL: climemu-0.1.9.tar.gz
  • Upload date:
  • Size: 29.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.8.15

File hashes

Hashes for climemu-0.1.9.tar.gz
Algorithm Hash digest
SHA256 5da1df2b21cc396bfb778acb17d4c83a8dcbeea347302de1433001301be9b699
MD5 a1ca87c8b0df1ffe7caa1e789a0a64aa
BLAKE2b-256 2e121fc7c806cb37155ac08a0327714e208098e588505efb2a6b3ab27c48d70b

See more details on using hashes here.

File details

Details for the file climemu-0.1.9-py3-none-any.whl.

File metadata

  • Download URL: climemu-0.1.9-py3-none-any.whl
  • Upload date:
  • Size: 36.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.8.15

File hashes

Hashes for climemu-0.1.9-py3-none-any.whl
Algorithm Hash digest
SHA256 566a01749342b10a0de6862ba971b2713be839ec9af3b5cf53f7b434b915da58
MD5 efd410a1ec3b2efaf9b309d0e2ceb8bc
BLAKE2b-256 6872861dddc1e5c8aae90dd5e5e29b789eba2c23f06d8f53b10c96b020332e4d

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