| Name | gpm-api JSON |
| Version |
0.3.0
JSON |
| download |
| home_page | None |
| Summary | Python Package for the Global Precipitation Measurement (GPM) Mission Data Archive |
| upload_time | 2024-08-28 09:26:00 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| 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. |
| keywords |
gpm
precipitation
api
dpr
pmw
imerg
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
|
# 📦 Welcome to GPM-API
| | |
| ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Deployment | [](https://pypi.org/project/gpm_api/) [](https://anaconda.org/conda-forge/gpm-api) |
| Activity | [](https://pypi.org/project/gpm_api/) [](https://anaconda.org/conda-forge/gpm-api) |
| Python Versions | [](https://www.python.org/downloads/) |
| Supported Systems | [](https://github.com/ghiggi/gpm_api/actions/workflows/tests.yaml) [](https://github.com/ghiggi/gpm_api/actions/workflows/tests.yaml) [](https://github.com/ghiggi/gpm_api/actions/workflows/tests_windows.yaml) |
| Project Status | [](https://www.repostatus.org/#active) |
| Build Status | [](https://github.com/ghiggi/gpm_api/actions/workflows/tests.yaml) [](https://github.com/ghiggi/gpm_api/actions/workflows/lint.yaml) [](https://gpm-api.readthedocs.io/en/latest/) |
| Linting | [](https://github.com/psf/black) [](https://github.com/astral-sh/ruff) [](https://github.com/codespell-project/codespell) |
| Code Coverage | [](https://coveralls.io/github/ghiggi/gpm_api?branch=main) [](https://codecov.io/gh/ghiggi/gpm_api) |
| Code Quality | [](https://www.codefactor.io/repository/github/ghiggi/gpm_api) [](https://codebeat.co/projects/github-com-ghiggi-gpm_api-main) [](https://app.codacy.com/gh/ghiggi/gpm_api/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade) [](https://codescene.io/projects/36767) |
| License | [](https://github.com/ghiggi/gpm_api/blob/main/LICENSE) |
| Community | [](https://join.slack.com/t/gpmapi/shared_invite/zt-28vkxzjs1-~cIYci2o3G0qEEoQJVMQRg) [](https://github.com/ghiggi/gpm_api/discussions) |
| Citation | [](https://doi.org/10.5281/zenodo.7753488) |
[**Slack**](https://join.slack.com/t/gpmapi/shared_invite/zt-28vkxzjs1-~cIYci2o3G0qEEoQJVMQRg) | [**Docs**](https://gpm-api.readthedocs.io/en/latest/)
## 🚀 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.available_products(product_types="RS") # research products
gpm.available_products(product_types="NRT") # near-real-time products
```
Before starting using GPM-API, we highly suggest to save into a configuration file:
1. your credentials to access the [NASA Precipitation Processing System (PPS) servers](https://gpm.nasa.gov/data/sources/pps-research)
1. 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
username_pps = "<your PPS username>" # likely your mail
password_pps = "<your PPS password>" # likely your mail
base_dir = "<path/to/directory/GPM" # path to the directory where to download the data
gpm.define_configs(
username_pps=username_pps, password_pps=password_pps, base_dir=base_dir
)
# 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
start_time = datetime.datetime(2020, 7, 22, 0, 1, 11)
end_time = datetime.datetime(2020, 7, 22, 0, 23, 5)
gpm.download(
product=product,
product_type=product_type,
version=version,
n_threads=2,
start_time=start_time,
end_time=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.open_granule(<path_to_granule>)
```
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
start_time = datetime.datetime(2020,7, 22, 0, 1, 11)
end_time = datetime.datetime(2020,7, 22, 0, 23, 5)
ds = gpm.open_dataset(product=product,
product_type=product_type,
version=version
start_time=start_time,
end_time=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/](https://gpm-api.readthedocs.io/en/latest/).
If you are new to GPM-API, we recommend starting with the following pages:
- [Introduction to GPM sensors, products, theoretical and practical aspects](https://gpm-api.readthedocs.io/en/latest/00_introduction.html)
- [Software installation](https://gpm-api.readthedocs.io/en/latest/02_installation.html)
- [Configuration of GPM-API to start download GPM Data from NASA PPS and GES DISC servers](https://gpm-api.readthedocs.io/en/latest/03_quickstart.html)
- [Basic tutorials on how to read, manipulate and visualize radar, passive microwave sensors and IMERG products](https://gpm-api.readthedocs.io/en/latest/04_tutorials.htmls)
All GPM-API tutorials are available as Jupyter Notebooks in the [`tutorial`](https://github.com/ghiggi/gpm_api/tree/main/tutorials) directory.
______________________________________________________________________
## 🛠️ Installation
### conda
GPM-API can be installed via [conda][conda_link] 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][conda_forge_link].
### pip
GPM-API can be installed also via [pip][pip_link] on Linux, Mac, and Windows.
On Windows you can install [WinPython][winpy_link] 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](https://libgeos.org/) 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][dev_install_link].
## 💭 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**](https://join.slack.com/t/gpmapi/shared_invite/zt-28vkxzjs1-~cIYci2o3G0qEEoQJVMQRg)
Feel free to also open a [GitHub Issue](https://github.com/ghiggi/gpm_api/issues) or a [GitHub Discussion](https://github.com/ghiggi/gpm_api/discussions) 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. [](https://doi.org/10.5281/zenodo.7753488)
If you want to cite a specific software version, have a look at the [Zenodo site](https://doi.org/10.5281/zenodo.7753488).
## License
The content of this repository is released under the terms of the [MIT license](LICENSE).
[conda_forge_link]: https://github.com/conda-forge/gpm-api-feedstock#installing-gpm-api
[conda_link]: https://docs.conda.io/en/latest/miniconda.html
[dev_install_link]: https://gpm-api.readthedocs.io/en/latest/02_installation.html#installation-for-contributors
[pip_link]: https://pypi.org/project/gpm-api
[winpy_link]: https://winpython.github.io/
Raw data
{
"_id": null,
"home_page": null,
"name": "gpm-api",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "GPM, Precipitation, API, DPR, PMW, IMERG",
"author": null,
"author_email": "Gionata Ghiggi <gionata.ghiggi@epfl.ch>",
"download_url": "https://files.pythonhosted.org/packages/cb/b7/f07d1ea4282b0b3b5abadb6b8e7884e54fdfef8aef067adfe1acf7125af0/gpm_api-0.3.0.tar.gz",
"platform": null,
"description": "# \ud83d\udce6 Welcome to GPM-API\n\n| | |\n| ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| Deployment | [](https://pypi.org/project/gpm_api/) [](https://anaconda.org/conda-forge/gpm-api) |\n| Activity | [](https://pypi.org/project/gpm_api/) [](https://anaconda.org/conda-forge/gpm-api) |\n| Python Versions | [](https://www.python.org/downloads/) |\n| Supported Systems | [](https://github.com/ghiggi/gpm_api/actions/workflows/tests.yaml) [](https://github.com/ghiggi/gpm_api/actions/workflows/tests.yaml) [](https://github.com/ghiggi/gpm_api/actions/workflows/tests_windows.yaml) |\n| Project Status | [](https://www.repostatus.org/#active) |\n| Build Status | [](https://github.com/ghiggi/gpm_api/actions/workflows/tests.yaml) [](https://github.com/ghiggi/gpm_api/actions/workflows/lint.yaml) [](https://gpm-api.readthedocs.io/en/latest/) |\n| Linting | [](https://github.com/psf/black) [](https://github.com/astral-sh/ruff) [](https://github.com/codespell-project/codespell) |\n| Code Coverage | [](https://coveralls.io/github/ghiggi/gpm_api?branch=main) [](https://codecov.io/gh/ghiggi/gpm_api) |\n| Code Quality | [](https://www.codefactor.io/repository/github/ghiggi/gpm_api) [](https://codebeat.co/projects/github-com-ghiggi-gpm_api-main) [](https://app.codacy.com/gh/ghiggi/gpm_api/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade) [](https://codescene.io/projects/36767) |\n| License | [](https://github.com/ghiggi/gpm_api/blob/main/LICENSE) |\n| Community | [](https://join.slack.com/t/gpmapi/shared_invite/zt-28vkxzjs1-~cIYci2o3G0qEEoQJVMQRg) [](https://github.com/ghiggi/gpm_api/discussions) |\n| Citation | [](https://doi.org/10.5281/zenodo.7753488) |\n\n[**Slack**](https://join.slack.com/t/gpmapi/shared_invite/zt-28vkxzjs1-~cIYci2o3G0qEEoQJVMQRg) | [**Docs**](https://gpm-api.readthedocs.io/en/latest/)\n\n## \ud83d\ude80 Quick start\n\nGPM-API provides an easy-to-use python interface to download, read, process and visualize most\nof the products of the Global Precipitation Measurement Mission (GPM) data archive.\n\nThe list of available products can be retrieved using:\n\n```python\nimport gpm\n\ngpm.available_products(product_types=\"RS\") # research products\ngpm.available_products(product_types=\"NRT\") # near-real-time products\n```\n\nBefore starting using GPM-API, we highly suggest to save into a configuration file:\n\n1. your credentials to access the [NASA Precipitation Processing System (PPS) servers](https://gpm.nasa.gov/data/sources/pps-research)\n1. the directory on the local disk where to save the GPM dataset of interest.\n\nTo facilitate the creation of the configuration file, you can run the following script:\n\n```python\nimport gpm\n\nusername_pps = \"<your PPS username>\" # likely your mail\npassword_pps = \"<your PPS password>\" # likely your mail\nbase_dir = \"<path/to/directory/GPM\" # path to the directory where to download the data\ngpm.define_configs(\n username_pps=username_pps, password_pps=password_pps, base_dir=base_dir\n)\n\n# You can check that the config file has been correctly created with:\nconfigs = gpm.read_configs()\nprint(configs)\n```\n\n______________________________________________________________________\n\n### \ud83d\udce5 Download GPM data\n\nNow you can either start to download GPM data within python:\n\n```python\nimport gpm\nimport datetime\n\nproduct = \"2A-DPR\"\nproduct_type = \"RS\"\nversion = 7\n\nstart_time = datetime.datetime(2020, 7, 22, 0, 1, 11)\nend_time = datetime.datetime(2020, 7, 22, 0, 23, 5)\n\ngpm.download(\n product=product,\n product_type=product_type,\n version=version,\n n_threads=2,\n start_time=start_time,\n end_time=end_time,\n)\n```\n\nor from the terminal using i.e. `download_daily_gpm_data <product> <year> <month> <day>`:\n\n```bash\ndownload_daily_gpm_data 2A-DPR 2022 7 22\n```\n\n______________________________________________________________________\n\n### \ud83d\udcab Open GPM files into xarray\n\nA GPM granule can be opened in python using:\n\n```python\nimport gpm\n\nds = gpm.open_granule(<path_to_granule>)\n\n```\n\nwhile multiple granules over a specific time period can be opened using:\n\n```python\nimport gpm\nimport datetime\n\nproduct = \"2A-DPR\"\nproduct_type = \"RS\"\nversion = 7\n\nstart_time = datetime.datetime(2020,7, 22, 0, 1, 11)\nend_time = datetime.datetime(2020,7, 22, 0, 23, 5)\nds = gpm.open_dataset(product=product,\n product_type=product_type,\n version=version\n start_time=start_time,\n end_time=end_time)\n```\n\n______________________________________________________________________\n\n### \ud83d\udcd6 Explore the GPM-API documentation\n\nTo discover all GPM-API download, manipulation, analysis and plotting features,\nplease read the software documentation available at [https://gpm-api.readthedocs.io/en/latest/](https://gpm-api.readthedocs.io/en/latest/).\n\nIf you are new to GPM-API, we recommend starting with the following pages:\n\n- [Introduction to GPM sensors, products, theoretical and practical aspects](https://gpm-api.readthedocs.io/en/latest/00_introduction.html)\n- [Software installation](https://gpm-api.readthedocs.io/en/latest/02_installation.html)\n- [Configuration of GPM-API to start download GPM Data from NASA PPS and GES DISC servers](https://gpm-api.readthedocs.io/en/latest/03_quickstart.html)\n- [Basic tutorials on how to read, manipulate and visualize radar, passive microwave sensors and IMERG products](https://gpm-api.readthedocs.io/en/latest/04_tutorials.htmls)\n\nAll GPM-API tutorials are available as Jupyter Notebooks in the [`tutorial`](https://github.com/ghiggi/gpm_api/tree/main/tutorials) directory.\n\n______________________________________________________________________\n\n## \ud83d\udee0\ufe0f Installation\n\n### conda\n\nGPM-API can be installed via [conda][conda_link] on Linux, Mac, and Windows.\nInstall the package by typing the following command in the terminal:\n\n```bash\nconda install gpm-api\n```\n\nIn case conda-forge is not set up for your system yet, see the easy to follow instructions on [conda-forge][conda_forge_link].\n\n### pip\n\nGPM-API can be installed also via [pip][pip_link] on Linux, Mac, and Windows.\nOn Windows you can install [WinPython][winpy_link] to get Python and pip running.\nPrior installation of GPM-API, try to install to `cartopy>=0.21.0` package to ensure there are not [GEOS](https://libgeos.org/) library version incompatibilities.\nIf 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`.\n\nThen, install the GPM-API package by typing the following command in the terminal:\n\n```bash\npip install gpm-api\n```\n\nTo install the latest development version via pip, see the [documentation][dev_install_link].\n\n## \ud83d\udcad Feedback and Contributing Guidelines\n\nIf you aim to contribute your data or discuss the future development of GPM-API,\nwe highly suggest to join the [**GPM-API Slack Workspace**](https://join.slack.com/t/gpmapi/shared_invite/zt-28vkxzjs1-~cIYci2o3G0qEEoQJVMQRg)\n\nFeel free to also open a [GitHub Issue](https://github.com/ghiggi/gpm_api/issues) or a [GitHub Discussion](https://github.com/ghiggi/gpm_api/discussions) specific to your questions or ideas.\n\n## Citation\n\nIf you are using GPM-API in your publication please cite our Zenodo repository:\n\n> Ghiggi Gionata. ghiggi/gpm_api. Zenodo. [](https://doi.org/10.5281/zenodo.7753488)\n\nIf you want to cite a specific software version, have a look at the [Zenodo site](https://doi.org/10.5281/zenodo.7753488).\n\n## License\n\nThe content of this repository is released under the terms of the [MIT license](LICENSE).\n\n[conda_forge_link]: https://github.com/conda-forge/gpm-api-feedstock#installing-gpm-api\n[conda_link]: https://docs.conda.io/en/latest/miniconda.html\n[dev_install_link]: https://gpm-api.readthedocs.io/en/latest/02_installation.html#installation-for-contributors\n[pip_link]: https://pypi.org/project/gpm-api\n[winpy_link]: https://winpython.github.io/\n",
"bugtrack_url": null,
"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. ",
"summary": "Python Package for the Global Precipitation Measurement (GPM) Mission Data Archive",
"version": "0.3.0",
"project_urls": {
"changelog": "https://github.com/ghiggi/gpm_api/blob/main/CHANGELOG.md",
"documentation": "https://gpm-api.readthedocs.io",
"homepage": "https://github.com/ghiggi/gpm_api",
"repository": "https://github.com/ghiggi/gpm_api",
"source": "https://github.com/ghiggi/gpm_api",
"tracker": "https://github.com/ghiggi/gpm_api/issues"
},
"split_keywords": [
"gpm",
" precipitation",
" api",
" dpr",
" pmw",
" imerg"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "575bcbb425e76ca4a8661b46aca78e6d0ca095c4e3e89c53eeba9a6867914330",
"md5": "9a52f17cc7bfeefa33c4752f969819b0",
"sha256": "eef1fd30ac2235221ebfb53a10ffb66085915484eee515d35aab2b6d928ccad5"
},
"downloads": -1,
"filename": "gpm_api-0.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9a52f17cc7bfeefa33c4752f969819b0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 341375,
"upload_time": "2024-08-28T09:25:58",
"upload_time_iso_8601": "2024-08-28T09:25:58.173662Z",
"url": "https://files.pythonhosted.org/packages/57/5b/cbb425e76ca4a8661b46aca78e6d0ca095c4e3e89c53eeba9a6867914330/gpm_api-0.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "cbb7f07d1ea4282b0b3b5abadb6b8e7884e54fdfef8aef067adfe1acf7125af0",
"md5": "dc926be355cd6b68b1b690f11365848b",
"sha256": "6185747f6f9c7b39e79eb8ae8e041d5a3035779b852d434088096b373f0e5268"
},
"downloads": -1,
"filename": "gpm_api-0.3.0.tar.gz",
"has_sig": false,
"md5_digest": "dc926be355cd6b68b1b690f11365848b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 257082,
"upload_time": "2024-08-28T09:26:00",
"upload_time_iso_8601": "2024-08-28T09:26:00.143899Z",
"url": "https://files.pythonhosted.org/packages/cb/b7/f07d1ea4282b0b3b5abadb6b8e7884e54fdfef8aef067adfe1acf7125af0/gpm_api-0.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-28 09:26:00",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ghiggi",
"github_project": "gpm_api",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "gpm-api"
}
