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/.

Metadata

Release files for gldas 0.7.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for gldas 0.7.3
File Size Uploaded
gldas-0.7.3.tar.gz 52.5 MB Details

Built distribution (wheel)

Table of built distributions (wheels) for gldas 0.7.3
File Interpreter ABI Platform
gldas-0.7.3-py3-none-any.whl Python 3 none any Details

Total release size: 52.6 MB

Release files / gldas-0.7.3.tar.gz

Download URL gldas-0.7.3.tar.gz
Size 52.5 MB
Tags Source
SHA-256 checksum
How to use checksums
c660934ed64efb44756e1100ff898513222e3c42caff3a51ee5e0a60da73839b
BLAKE2b-256 checksum
How to use checksums
999cc5a5bb288b6969eeaf493eee923ec8b105feb1bd8a29e18277fe4c0f475f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.14

Release files / gldas-0.7.3-py3-none-any.whl

Download URL gldas-0.7.3-py3-none-any.whl
Size 69.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
66552e39a3e8f463640ad5c991628379f64b23af322bc865477d1a604ec45ca5
BLAKE2b-256 checksum
How to use checksums
01dd4c6a0a69e9fd18589447d4f559a9b8af4a1a23205633d44f6c07ebdcb578
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.14

Release history Release notifications | RSS feed

This release

0.7.3 This release

2 release files

0.7.2

2 release files

0.7.1

2 release files

0.7.0

2 release files

0.6.1

1 release file

0.6

1 release file

0.5

1 release file

0.4

1 release file

0.3

2 release files

0.2

2 release files

0.1

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page