zampy

Tool for downloading Land Surface Model input data

Tool outline:

• Goal is to retrieve data for LSM model input.
  1. First download the data for the specified location(s) / geographical area.
  2. Be able to load the variables in a standardized way (standardized names & standardized units).
  3. Output the data to standard formats:
     • ALMA / PLUMBER2's ALMA formatted netCDF.
     • CMOR formatted netCDF.
• User-interaction should go through recipes. For example, see springtime.
  • Recipes define:
    • data folder (where data should be downloaded to)
    • time extent.
    • spatial location / bounding box.
    • datasets to be used
      • variables within datasets
  • Load recipes using Pydantic (for example).
• Support both a CLI & Python API.

Note: items in italic will not be worked on for now/low priority, but we want to allow space for these in the future.

Instructions for CDS datasets (e.g. ERA5)

To download the following datasets, users need access to CDS via cdsapi:

• ERA5
• ERA5 land
• LAI

First, you need to be a registered user on CDS via the registration page.

Before submitting any request with zampy, please configure your zampy config file zampy_config.yml and put your cdsapi credentials in zampy_config.yml. Here is a short instruction about how to find your CDS API key. You can skip the steps related to .cdsapirc and instead create zampy_config.yml file under your user home/.config directory i.e. ~/.config/zampy/zampy_config.yml. Then, add the key as:

cdsapi:
  url:  # for example https://cds.climate.copernicus.eu/api/v2
  key:  # for example 12345:xhashd-232jcsha-dsaj429-cdjajd29319

Instructions for ADS datasets (e.g. CAMS EGG4)

To download the following datasets, users need access to ADS via cdsapi:

• CAMS EGG4 (e.g. co2)

First, you need to be a registered user on ADS via the registration page.

Before submitting any request with zampy, please configure your zampy config file zampy_config.yml and put your cdsapi credentials in zampy_config.yml. Here is a short instruction about how to find your CDS API key. You can skip the steps related to .cdsapirc and instead create zampy_config.yml file under your user home/.config directory i.e. ~/.config/zampy/zampy_config.yml. Then, add the key as:

adsapi:
  url:  # for example https://ads.atmosphere.copernicus.eu/api/v2
  key:  # for example 12345:xhashd-232jcsha-dsaj429-cdjajd29319

Agree to the Terms of Use on CDS/ADS

When downloading a dataset for the first time, it is necessary to agree to the Terms of Use of every datasets that you intend to download. This can only be done via the CDS website. When you try to download these datasets, you will be prompted to go to the terms of use and accept them.