Science Score: 44.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found 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 (16.4%) to scientific vocabulary
Repository
Tool for downloading Land Surface Model input data
Basic Info
- Host: GitHub
- Owner: EcoExtreML
- License: apache-2.0
- Language: Python
- Default Branch: main
- Homepage: https://zampy.readthedocs.io/
- Size: 2.78 MB
Statistics
- Stars: 1
- Watchers: 4
- Forks: 0
- Open Issues: 25
- Releases: 1
Metadata Files
README.md
zampy
Tool for downloading Land Surface Model (LSM) input data.
Named after Zam; the Avestan language term for the Zoroastrian concept of "earth".
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
To install the latest release of zampy, do:
console
python3 -m pip install zampy
To install the in-development version from the GitHub repository, do:
console
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:
yaml
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:
yaml
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:
py
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.
Owner
- Name: Ecosystem Functioning under Extreme Climates with Physics-Aware Machine Learning
- Login: EcoExtreML
- Kind: organization
- Website: https://research-software-directory.org/projects/ecoextreml
- Repositories: 1
- Profile: https://github.com/EcoExtreML
Project with Netherlands eScience Center and University of Twente
Citation (CITATION.cff)
# YAML 1.2
---
cff-version: "1.1.0"
title: "zampy"
authors:
-
affiliation: "Netherlands eScience Center"
family-names: Schilperoort
given-names: Bart
orcid: "https://orcid.org/0000-0003-4487-9822"
-
affiliation: "Netherlands eScience Center"
family-names: Alidoost
given-names: Sarah
orcid: "https://orcid.org/0000-0001-8407-6472"
-
affiliation: "Netherlands eScience Center"
family-names: Liu
given-names: Yang
orcid: "https://orcid.org/0000-0002-1966-8460"
date-released: <add release date>
doi: <insert your DOI here>
version: "0.0.1"
repository-code: "https://github.com/EcoExtreML/zampy"
keywords:
- data preparation
- land surface modelling
message: "If you use this software, please cite it using these metadata."
license: Apache-2.0
GitHub Events
Total
- Issues event: 11
- Delete event: 4
- Issue comment event: 28
- Push event: 28
- Pull request review event: 17
- Pull request review comment event: 24
- Pull request event: 8
- Create event: 3
Last Year
- Issues event: 11
- Delete event: 4
- Issue comment event: 28
- Push event: 28
- Pull request review event: 17
- Pull request review comment event: 24
- Pull request event: 8
- Create event: 3
Issues and Pull Requests
Last synced: 10 months ago
All Time
- Total issues: 44
- Total pull requests: 26
- Average time to close issues: about 2 months
- Average time to close pull requests: 19 days
- Total issue authors: 6
- Total pull request authors: 3
- Average comments per issue: 1.05
- Average comments per pull request: 2.77
- Merged pull requests: 25
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 7
- Pull requests: 5
- Average time to close issues: 14 days
- Average time to close pull requests: 11 days
- Issue authors: 2
- Pull request authors: 1
- Average comments per issue: 0.29
- Average comments per pull request: 1.2
- Merged pull requests: 4
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- BSchilperoort (20)
- SarahAlidoost (10)
- geek-yang (9)
- retsios (2)
- yijianzeng (2)
- prajzwal08 (2)
Pull Request Authors
- BSchilperoort (13)
- SarahAlidoost (9)
- geek-yang (8)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
-
Total downloads:
- pypi 22 last-month
- Total dependent packages: 0
- Total dependent repositories: 0
- Total versions: 2
- Total maintainers: 3
pypi.org: zampy
python package for getting Land Surface Model input data.
- Documentation: https://zampy.readthedocs.io/
- License: Apache Software License
-
Latest release: 0.2.0
published almost 2 years ago