Skip to main content

python package for getting Land Surface Model input data.

Project description

zampy

Tool for downloading Land Surface Model (LSM) input data.

Named after Zam; the Avestan language term for the Zoroastrian concept of "earth".

github license badge Documentation Status build workflow scc badge

Outline

zampy is designed to retrieve data for LSM model input. It can help you prepare the data within the following steps:

  1. Download the data for the specified location(s) / geographical area.
  2. Ingest data into unified (zampy) format.
  3. Load the variables in a standardized way (standardized names & standardized units).
  4. Convert the data to standard formats:
    • ALMA / PLUMBER2's ALMA formatted netCDF.
    • CMOR formatted netCDF.

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

Getting start

Installation

workflow pypi badge supported python versions

To install the latest release of zampy, do:

python3 -m pip install zampy

To install the in-development version from the GitHub repository, do:

python3 -m pip install git+https://github.com/EcoExtreML/zampy.git

Configuration

Zampy needs to be configured with a simple configuration file.

You need to create this file under your user home directory:

~/.config/zampy/zampy_config.yml

The configuration file should contain the working_directory, for instance:

working_directory: /path_to_a_working_directory/  #for example: /home/bart/Zampy

If you need access to data on CDS or ADS server, you should add your CDS or ADS credentials to zampy_config.yml:

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

About how to create CDS or ADS credentials, check the section below.

How to use zampy

We recommend our users to use zampy with recipes.

A "recipe" is a file with yml extension, it defines:

  • data downloading
    • time extent.
    • spatial location / bounding box.
    • datasets to be downloaded
      • variables within datasets
  • data conversion
    • convert to desired conventions
    • output frequency
    • output resolution

A sample recipe can be found in the documentation.

When you have your reciped created and saved on your disk, you can execute your recipe by running the following code in your shell:

zampy /path_to_recipe/sample_recipe.yml

We also provide python API for you to intereact with zampy. You can find the example notebooks for each supported dataset here.

Instructions for CDS/ADS datasets

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

  • CDS
    • ERA5
    • ERA5 land
    • LAI
    • land cover
  • ADS
    • CAMS EGG4 (e.g. co2)

To generate these API keys, you need to be a registered user on CDS via the registration page, or on ADS via the registration page.

Before submitting any request with zampy, please put your cdsapi/adsapi credentials in zampy_config.yml. Here is a short instruction about how to find your CDS/ADS API key. You can skip the steps related to .cdsapirc and simply add the key to zampy_config.yml.

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/ADS website. When you try to download these datasets, you will be prompted to go to the terms of use and accept them.

Acknowledgements

This package was developed by the Netherlands eScience Center. Development was supported by the Netherlands eScience Center under grant number NLESC.ASDI.2020.026.

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

zampy-0.2.0.tar.gz (2.8 MB view details)

Uploaded Source

Built Distribution

zampy-0.2.0-py3-none-any.whl (280.7 kB view details)

Uploaded Python 3

File details

Details for the file zampy-0.2.0.tar.gz.

File metadata

  • Download URL: zampy-0.2.0.tar.gz
  • Upload date:
  • Size: 2.8 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-httpx/0.27.2

File hashes

Hashes for zampy-0.2.0.tar.gz
Algorithm Hash digest
SHA256 0f60448ca7f0573df4c1046b47ceb632393ed9f8c63597c77bfcfbe23e4b721e
MD5 10108f2aeb5c52172f08c9030b0fc001
BLAKE2b-256 d83a87ee720b7640d585fb8a835f9fe34e20569ab0278588d6432e2dd61bfa02

See more details on using hashes here.

Provenance

File details

Details for the file zampy-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: zampy-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 280.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-httpx/0.27.2

File hashes

Hashes for zampy-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 67199426c049810060b2db8877d3903e299f1e484b7d454c913ece723e2a48cc
MD5 c8bd7b9df1be22a14b96bdca9283dfdf
BLAKE2b-256 b571b13aa0447fd154e3d39b26a3615ef12724958a48e766ec11d9361b55af54

See more details on using hashes here.

Provenance

Supported by

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