gpm-api

A python package to download and analyze the Global Precipitation Measurement Mission (GPM) data archive

Keywords

analysis-ready-data earth-observation eumetsat gpm jaxa nasa noaa open-data passive-microwave precipitation python radar rainfall reflectivity remote-sensing reproducible-research satellite-data snowfall trmm xarray

Keywords from Contributors

mesh resample interactive optimizer yolov5s spacy-extension pipeline-testing hydrology regionalization datacleaner

Last synced: 6 months ago · JSON representation ·

Repository

A python package to download and analyze the Global Precipitation Measurement Mission (GPM) data archive

Basic Info

Host: GitHub
Owner: ghiggi
License: mit
Language: Jupyter Notebook
Default Branch: main
Homepage: https://gpm-api.readthedocs.io
Size: 135 MB

Statistics

Stars: 69
Watchers: 1
Forks: 8
Open Issues: 5
Releases: 19

Topics

analysis-ready-data earth-observation eumetsat gpm jaxa nasa noaa open-data passive-microwave precipitation python radar rainfall reflectivity remote-sensing reproducible-research satellite-data snowfall trmm xarray

Created over 5 years ago · Last pushed 6 months ago

Metadata Files

Readme Changelog Contributing License Code of conduct Citation Authors

README.md

| | | | ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Deployment | | | Activity | | | Python Versions | | | Supported Systems | | | Project Status | | | Build Status | | | Linting | | | Code Coverage | | | Code Quality | | | License | | | Community | | | Citation | |

Slack | Documentation

🚀 Quick start

GPM-API provides an easy-to-use python interface to download, read, process and visualize most of the products of the Global Precipitation Measurement Mission (GPM) data archive.

The list of available products can be retrieved using:

```python import gpm

gpm.availableproducts(producttypes="RS") # research products gpm.availableproducts(producttypes="NRT") # near-real-time products ```

Before starting using GPM-API, we highly suggest to save into a configuration file:

your credentials to access the NASA Precipitation Processing System (PPS) servers
the directory on the local disk where to save the GPM dataset of interest.

To facilitate the creation of the configuration file, you can run the following script:

```python import gpm

usernamepps = "" # likely your mail passwordpps = "" # likely your mail basedir = "<path/to/directory/GPM" # path to the directory where to download the data gpm.defineconfigs( usernamepps=usernamepps, passwordpps=passwordpps, basedir=basedir )

You can check that the config file has been correctly created with:

configs = gpm.read_configs() print(configs) ```

📥 Download GPM data

Now you can either start to download GPM data within python:

```python import gpm import datetime

product = "2A-DPR" product_type = "RS" version = 7

starttime = datetime.datetime(2020, 7, 22, 0, 1, 11) endtime = datetime.datetime(2020, 7, 22, 0, 23, 5)

gpm.download( product=product, producttype=producttype, version=version, nthreads=2, starttime=starttime, endtime=end_time, ) ```

or from the terminal using i.e. download_daily_gpm_data <product> <year> <month> <day>:

bash download_daily_gpm_data 2A-DPR 2022 7 22

💫 Open GPM files into xarray

A GPM granule can be opened in python using:

```python import gpm

ds = gpm.opengranuledataset()

or

dt = gpm.opengranuledatatree()

```

while multiple granules over a specific time period can be opened using:

```python import gpm import datetime

product = "2A-DPR" product_type = "RS" version = 7

starttime = datetime.datetime(2020,7, 22, 0, 1, 11) endtime = datetime.datetime(2020,7, 22, 0, 23, 5) ds = gpm.opendataset(product=product, producttype=producttype, version=version starttime=starttime, endtime=end_time) ```

📖 Explore the GPM-API documentation

To discover all GPM-API download, manipulation, analysis and plotting features, please read the software documentation available at https://gpm-api.readthedocs.io/en/latest/.

If you are new to GPM-API, we recommend starting with the following pages:

All GPM-API tutorials are available as Jupyter Notebooks in the tutorial directory.

🛠️ Installation

conda

GPM-API can be installed via conda on Linux, Mac, and Windows. Install the package by typing the following command in the terminal:

bash conda install gpm-api

In case conda-forge is not set up for your system yet, see the easy to follow instructions on conda-forge.

pip

GPM-API can be installed also via pip on Linux, Mac, and Windows. On Windows you can install WinPython to get Python and pip running. Prior installation of GPM-API, try to install to cartopy>=0.21.0 package to ensure there are not GEOS library version incompatibilities. If you can't solve the problems and install cartopy with pip, you should install at least cartopy with conda using conda install cartopy>=0.21.0.

Then, install the GPM-API package by typing the following command in the terminal:

bash pip install gpm-api

To install the latest development version via pip, see the documentation.

💭 Feedback and Contributing Guidelines

If you aim to contribute your data or discuss the future development of GPM-API, we highly suggest to join the GPM-API Slack Workspace

Feel free to also open a GitHub Issue or a GitHub Discussion specific to your questions or ideas.

Citation

If you are using GPM-API in your publication please cite our Zenodo repository:

Ghiggi Gionata. ghiggi/gpm_api. Zenodo.

If you want to cite a specific software version, have a look at the Zenodo site.

License

The content of this repository is released under the terms of the MIT license.

Owner

Name: Gionata Ghiggi
Login: ghiggi
Kind: user

Repositories: 22
Profile: https://github.com/ghiggi

Citation (CITATION.bib)

@Article{gmd-XX-XXXX-2024,
AUTHOR = {Ghiggi, G. and ....},
TITLE = {\texttt{GPM-API} v1.0: An API to access and process the Global Precipitation Measurement data archive},
JOURNAL = {Geoscientific Model Development},
VOLUME = {XX},
YEAR = {XX},
NUMBER = {XX},
PAGES = {XXXX--XXXX},
URL = {https://gmd.copernicus.org/articles/XX/XXXX/2024/},
DOI = {10.5194/gmd-XX-XXXX-XXXX}
}

GitHub Events

Total

Create event: 6
Release event: 3
Issues event: 7
Watch event: 12
Delete event: 2
Issue comment event: 15
Push event: 106
Pull request event: 11
Fork event: 3

Last Year

Create event: 6
Release event: 3
Issues event: 7
Watch event: 12
Delete event: 2
Issue comment event: 15
Push event: 106
Pull request event: 11
Fork event: 3

Committers

Last synced: 6 months ago

All Time

Total Commits: 619
Total Committers: 6
Avg Commits per committer: 103.167
Development Distribution Score (DDS): 0.313

Past Year

Commits: 40
Committers: 2
Avg Commits per committer: 20.0
Development Distribution Score (DDS): 0.05

Top Committers

Name	Email	Commits
ghiggi	g**i@g**m	425
Son Pham-Ba	s**a@e**h	140
Evan Thomas	e**s@e**h	41
dependabot[bot]	4****]	6
pre-commit-ci[bot]	6****]	4
Randy J. Chase	r**2@g**m	3

Committer Domains (Top 20 + Academic)

epfl.ch: 2

Issues and Pull Requests

Last synced: 6 months ago

All Time

Total issues: 16
Total pull requests: 101
Average time to close issues: 26 days
Average time to close pull requests: 23 days
Total issue authors: 10
Total pull request authors: 7
Average comments per issue: 0.63
Average comments per pull request: 1.58
Merged pull requests: 75
Bot issues: 0
Bot pull requests: 31

Past Year

Issues: 5
Pull requests: 18
Average time to close issues: 1 day
Average time to close pull requests: 2 months
Issue authors: 4
Pull request authors: 3
Average comments per issue: 0.2
Average comments per pull request: 1.06
Merged pull requests: 11
Bot issues: 0
Bot pull requests: 10

View more stats

Top Authors

Issue Authors

ghiggi (3)
kmuehlbauer (3)
kaushikCanada (2)
sanjit-bs (2)
lllliso (1)
ankithva (1)
DavidChoi76 (1)
naseefo (1)
sphamba (1)
edsml-ds423 (1)

Pull Request Authors

ghiggi (36)
sphamba (29)
pre-commit-ci[bot] (19)
dependabot[bot] (12)
kmuehlbauer (2)
dopplerchase (2)
evanjt (1)

Top Labels

Issue Labels

enhancement (5) bug (3)

Pull Request Labels

dependencies (12) documentation (2)

Packages

Total packages: 2
Total downloads:
- pypi 205 last-month

Total dependent packages: 0
(may contain duplicates)
Total dependent repositories: 0
(may contain duplicates)
Total versions: 39
Total maintainers: 1

proxy.golang.org: github.com/ghiggi/gpm_api

Documentation: https://pkg.go.dev/github.com/ghiggi/gpm_api#section-documentation
License: mit
Latest release: v0.3.4
published 11 months ago

Versions: 20
Dependent Packages: 0
Dependent Repositories: 0

Rankings

Dependent packages count: 5.4%

Average: 5.6%

Dependent repos count: 5.8%

Last synced: 6 months ago

pypi.org: gpm-api

Python Package for the Global Precipitation Measurement (GPM) Mission Data Archive

Documentation: https://gpm-api.readthedocs.io/
License: MIT License Copyright (c) 2023 Gionata Ghiggi Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Latest release: 0.3.4
published 11 months ago

Versions: 19
Dependent Packages: 0
Dependent Repositories: 0
Downloads: 205 Last month

Rankings

Dependent packages count: 6.6%

Average: 23.3%

Stargazers count: 25.5%

Forks count: 30.5%

Dependent repos count: 30.6%

Maintainers (1)

ghiggi

Last synced: 6 months ago

Dependencies

pyproject.toml pypi

cartopy >=0.20.0
dask *
h5py *
netcdf4 *
pyresample *
tqdm *
trollsift *
wget *
xarray *

.github/workflows/lint.yml actions

actions/checkout v3 composite
actions/setup-python v4 composite
pre-commit/action v3.0.0 composite

.github/workflows/release_to_pypi.yml actions

actions/checkout v2 composite
actions/create-release v1 composite
actions/setup-python v2 composite
actions/upload-release-asset v1 composite
pypa/gh-action-pypi-publish release/v1 composite

.github/workflows/tests.yml actions

actions/checkout v3 composite
codecov/codecov-action v3 composite
coverallsapp/github-action v2 composite
mamba-org/setup-micromamba v1 composite

ci/environment.yml pypi

pycolorbar *
ximage *

setup.py pypi

gpm-api

Science Score: 77.0%

Keywords

Keywords from Contributors

Repository

Basic Info

Statistics

Topics

Metadata Files

README.md

🚀 Quick start

You can check that the config file has been correctly created with:

📥 Download GPM data

💫 Open GPM files into xarray

or

📖 Explore the GPM-API documentation

🛠️ Installation

conda

pip

💭 Feedback and Contributing Guidelines

Citation

License

Owner

Citation (CITATION.bib)

GitHub Events

Total

Last Year

Committers

All Time

Past Year

Top Committers

Committer Domains (Top 20 + Academic)

Issues and Pull Requests

All Time

Past Year

Top Authors

Issue Authors

Pull Request Authors

Top Labels

Issue Labels

Pull Request Labels

Packages

proxy.golang.org: github.com/ghiggi/gpm_api

Rankings

pypi.org: gpm-api

Rankings

Maintainers (1)

Dependencies