Skip to main content

ci cov pip doc

Readers and converters for data from the GLDAS Noah Land Surface Model. Written in Python.

Works great in combination with pytesmo.

Citation

https://zenodo.org/badge/DOI/10.5281/zenodo.596427.svg

If you use the software in a publication then please cite it using the Zenodo DOI. Be aware that this badge links to the latest package version.

Please select your specific version at https://doi.org/10.5281/zenodo.596427 to get the DOI of that version. You should normally always use the DOI for the specific version of your record in citations. This is to ensure that other researchers can access the exact research artefact you used for reproducibility.

You can find additional information regarding DOI versioning at http://help.zenodo.org/#versioning

Installation

This package can be installed via pip from pypi.org. The minimum supported python version is 3.10.

You can install the gldas package and all required dependencies via

pip install gldas

Optional dependencies

To read grib versions of GLDAS Noah, please install pygrib first:

pip install pygrib

On windows it might be necessary to use conda:

conda install -c conda-forge pygrib

Supported Products

At the moment this package supports GLDAS Noah data version 1 in grib format (reading, time series creation) and GLDAS Noah data version 2.0 and version 2.1 in netCDF format (download, reading, time series creation) with a spatial sampling of 0.25 degrees. It should be easy to extend the package to support other GLDAS based products. This will be done as need arises.

Contribute

We are happy if you want to contribute. Please raise an issue explaining what is missing or if you find a bug. We will also gladly accept pull requests against our master branch for new features or bug fixes.

Development setup

For Development we also recommend a conda environment. You can create one including test dependencies and debugger by running conda create -n gldas python=3.12, then activate it and call pip install -e .[testing] to install the package and all required and test dependencies. Now everything should be in place to run tests and develop new features.

Guidelines

If you want to contribute please follow these steps:

  • Fork the gldas repository to your account

  • Clone the repository, make sure you use git clone --recursive to also get the test data repository.

  • make a new feature branch from the gldas master branch

  • Add your feature

  • Please include tests for your contributions in one of the test directories. We use py.test so a simple function called test_my_feature is enough

  • submit a pull request to our master branch

Note

This project has been set up using PyScaffold 4.6. For details and usage information on PyScaffold see https://pyscaffold.org/.

Download files

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

Source Distribution

gldas-0.7.3.tar.gz (52.5 MB view details)

Uploaded Source

Built Distribution

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

gldas-0.7.3-py3-none-any.whl (69.4 kB view details)

Uploaded Python 3

File details

Details for the file gldas-0.7.3.tar.gz.

File metadata

  • Download URL: gldas-0.7.3.tar.gz
  • Upload date:
  • Size: 52.5 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for gldas-0.7.3.tar.gz
Algorithm Hash digest
SHA256 c660934ed64efb44756e1100ff898513222e3c42caff3a51ee5e0a60da73839b
MD5 4b8588da464116b0f3946143d7981412
BLAKE2b-256 999cc5a5bb288b6969eeaf493eee923ec8b105feb1bd8a29e18277fe4c0f475f

See more details on using hashes here.

File details

Details for the file gldas-0.7.3-py3-none-any.whl.

File metadata

  • Download URL: gldas-0.7.3-py3-none-any.whl
  • Upload date:
  • Size: 69.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for gldas-0.7.3-py3-none-any.whl
Algorithm Hash digest
SHA256 66552e39a3e8f463640ad5c991628379f64b23af322bc865477d1a604ec45ca5
MD5 1271b0539eeb6aa3ac39c251758c1ed7
BLAKE2b-256 01dd4c6a0a69e9fd18589447d4f559a9b8af4a1a23205633d44f6c07ebdcb578

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 Sentry Error logging StatusPage Status page