| Name | goes-api JSON |
| Version |
0.1.3
JSON |
| download |
| home_page | |
| Summary | Python API for downloading and searching GOES-16/17 satellite data on local and cloud storage. |
| upload_time | 2023-03-31 07:46:42 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.7 |
| 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 |
goes-16
goes-17
abi
glm
satellite
weather
meteorology
forecasting
ews
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Welcome to GOES API - An API to download and search for GOES satellite data.
[](https://zenodo.org/badge/latestdoi/380300525)
[](https://badge.fury.io/py/goes_api)
[](https://anaconda.org/conda-forge/goes_api)
[](https://github.com/ghiggi/goes_api/actions)
[](https://coveralls.io/github/ghiggi/goes_api?branch=main)
[](https://gpm_api.readthedocs.io/projects/goes_api/en/stable/?badge=stable)
[](https://github.com/ambv/black)
[](https://github.com/ghiggi/goes_api/blob/master/LICENSE)
The GOES-API is still in development. Feel free to try it out and to report issues or to suggest changes.
## Quickstart
The code in this repository provides an API to download, query and filter GOES16 and GOES17 satellite data.
Data download and query/filtering is available:
- for local file systems, Google Cloud Storage and AWS S3.
- for sensors ABI, EXIS, GLM, MAG, SEIS and SUVI.
The folder `tutorials` provide the following jupyter notebooks, describing various features of `GOES_API`:
- Downloading GOES data: [`download.ipynb`]
- Find and filter GOES data: [`find_and_filter.ipynb`]
- Read data directly from AWS S3 and GCS buckets: [`read_bucket_data.ipynb`]
- Read ABI L1B and L2B products from cloud buckets and plot it with satpy: [`read_bucket_data_with_satpy.ipynb`]
- Extract zarr reference files using kerchunk: [`kerchunk_data.ipynb`]
[`download.ipynb`]: https://github.com/ghiggi/goes_api/blob/main/tutorials/00_download_and_find_files.py
[`find_and_filter.ipynb`]: https://github.com/ghiggi/goes_api/blob/main/tutorials/01_find_utility.py
[`read_bucket_data.ipynb`]: https://github.com/ghiggi/goes_api/blob/main/tutorials/03_read_cloud_bucket_data.py
[`read_bucket_data_with_satpy.ipynb`]: https://github.com/ghiggi/goes_api/blob/main/tutorials/03_read_cloud_bucket_data_with_satpy.py
[`kerchunk_data.ipynb`]: https://github.com/ghiggi/goes_api/blob/main/tutorials/04_kerchunk_dataset.py
The folder `docs` contains documents with various information related to GOES data products.
Documentation is available at XXXXX
## Installation
### pip
GOES-API can be installed via [pip][pip_link] on Linux, Mac, and Windows.
On Windows you can install [WinPython][winpy_link] to get Python and pip running.
Then, install the GOES-API package by typing the following command in the command terminal:
pip install goes_api
## Citation
If you are using GOES-API, please cite:
> Ghiggi Gionata. ghiggi/goes_api. Zenodo. https://doi.org/10.5281/zenodo.7787851
If you want to cite a specific version, have a look at the [Zenodo site](https://doi.org/10.5281/zenodo.7787851).
## Contributors
* [Gionata Ghiggi](https://people.epfl.ch/gionata.ghiggi)
## License
The content of this repository is released under the terms of the [MIT](LICENSE) license.
[pip_link]: https://pypi.org/project/gstools
[winpy_link]: https://winpython.github.io/
Raw data
{
"_id": null,
"home_page": "",
"name": "goes-api",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "GOES-16,GOES-17,ABI,GLM,satellite,weather,meteorology,forecasting,EWS",
"author": "",
"author_email": "Gionata Ghiggi <gionata.ghiggi@epfl.ch>",
"download_url": "https://files.pythonhosted.org/packages/39/c8/01528b6e5ad70b4cacaa2e9a6a84e440f81fac477be2d9864eb3f3b6d861/goes_api-0.1.3.tar.gz",
"platform": null,
"description": "# Welcome to GOES API - An API to download and search for GOES satellite data.\n[](https://zenodo.org/badge/latestdoi/380300525)\n[](https://badge.fury.io/py/goes_api)\n[](https://anaconda.org/conda-forge/goes_api)\n[](https://github.com/ghiggi/goes_api/actions)\n[](https://coveralls.io/github/ghiggi/goes_api?branch=main)\n[](https://gpm_api.readthedocs.io/projects/goes_api/en/stable/?badge=stable)\n[](https://github.com/ambv/black)\n[](https://github.com/ghiggi/goes_api/blob/master/LICENSE)\n\nThe GOES-API is still in development. Feel free to try it out and to report issues or to suggest changes.\n\n## Quickstart\n\nThe code in this repository provides an API to download, query and filter GOES16 and GOES17 satellite data.\n\nData download and query/filtering is available:\n- for local file systems, Google Cloud Storage and AWS S3.\n- for sensors ABI, EXIS, GLM, MAG, SEIS and SUVI.\n\nThe folder `tutorials` provide the following jupyter notebooks, describing various features of `GOES_API`:\n\n- Downloading GOES data: [`download.ipynb`]\n- Find and filter GOES data: [`find_and_filter.ipynb`]\n- Read data directly from AWS S3 and GCS buckets: [`read_bucket_data.ipynb`]\n- Read ABI L1B and L2B products from cloud buckets and plot it with satpy: [`read_bucket_data_with_satpy.ipynb`]\n- Extract zarr reference files using kerchunk: [`kerchunk_data.ipynb`]\n\n[`download.ipynb`]: https://github.com/ghiggi/goes_api/blob/main/tutorials/00_download_and_find_files.py\n[`find_and_filter.ipynb`]: https://github.com/ghiggi/goes_api/blob/main/tutorials/01_find_utility.py\n[`read_bucket_data.ipynb`]: https://github.com/ghiggi/goes_api/blob/main/tutorials/03_read_cloud_bucket_data.py\n[`read_bucket_data_with_satpy.ipynb`]: https://github.com/ghiggi/goes_api/blob/main/tutorials/03_read_cloud_bucket_data_with_satpy.py\n[`kerchunk_data.ipynb`]: https://github.com/ghiggi/goes_api/blob/main/tutorials/04_kerchunk_dataset.py\n\nThe folder `docs` contains documents with various information related to GOES data products.\n\nDocumentation is available at XXXXX\n\n## Installation\n\n### pip\n\nGOES-API can be installed via [pip][pip_link] on Linux, Mac, and Windows.\nOn Windows you can install [WinPython][winpy_link] to get Python and pip running.\n\nThen, install the GOES-API package by typing the following command in the command terminal:\n\n pip install goes_api\n\n## Citation\n\nIf you are using GOES-API, please cite:\n\n> Ghiggi Gionata. ghiggi/goes_api. Zenodo. https://doi.org/10.5281/zenodo.7787851\n\nIf you want to cite a specific version, have a look at the [Zenodo site](https://doi.org/10.5281/zenodo.7787851).\n\n## Contributors\n\n* [Gionata Ghiggi](https://people.epfl.ch/gionata.ghiggi)\n\n## License\n\nThe content of this repository is released under the terms of the [MIT](LICENSE) license.\n\n[pip_link]: https://pypi.org/project/gstools\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 API for downloading and searching GOES-16/17 satellite data on local and cloud storage.",
"version": "0.1.3",
"split_keywords": [
"goes-16",
"goes-17",
"abi",
"glm",
"satellite",
"weather",
"meteorology",
"forecasting",
"ews"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9ba1207ed00773e8668e76cc821543d21efc4e89091e09fc96947cc18969c093",
"md5": "b71b76bacdff2ef5232e0dc6c77d1f26",
"sha256": "b4a6e0306a7dcf5e18194401e13d64c9077e7211764e03cce77f801b5d65dd3f"
},
"downloads": -1,
"filename": "goes_api-0.1.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b71b76bacdff2ef5232e0dc6c77d1f26",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 3247554,
"upload_time": "2023-03-31T07:46:39",
"upload_time_iso_8601": "2023-03-31T07:46:39.660245Z",
"url": "https://files.pythonhosted.org/packages/9b/a1/207ed00773e8668e76cc821543d21efc4e89091e09fc96947cc18969c093/goes_api-0.1.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "39c801528b6e5ad70b4cacaa2e9a6a84e440f81fac477be2d9864eb3f3b6d861",
"md5": "b2934396b6643f6db771ff7df5f38603",
"sha256": "b31453cb6f8f195ee2e6eba4dd9a05aa4bf0bc591edc17958eb64282793bf37e"
},
"downloads": -1,
"filename": "goes_api-0.1.3.tar.gz",
"has_sig": false,
"md5_digest": "b2934396b6643f6db771ff7df5f38603",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 3157550,
"upload_time": "2023-03-31T07:46:42",
"upload_time_iso_8601": "2023-03-31T07:46:42.980718Z",
"url": "https://files.pythonhosted.org/packages/39/c8/01528b6e5ad70b4cacaa2e9a6a84e440f81fac477be2d9864eb3f3b6d861/goes_api-0.1.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-03-31 07:46:42",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "goes-api"
}
