himawari-api


Namehimawari-api JSON
Version 0.0.2 PyPI version JSON
download
home_page
SummaryPython API for downloading and searching Himawari satellite data on local and cloud storage.
upload_time2023-03-31 08:07:35
maintainer
docs_urlNone
author
requires_python>=3.7
licenseMIT 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 himawari-8 himawari-9 ahi satellite weather meteorology forecasting ews
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Welcome to HIMAWARI API - An API to download and search HIMAWARI satellite data.
[![DOI](https://zenodo.org/badge/538957326.svg)](https://zenodo.org/badge/latestdoi/538957326)
[![PyPI version](https://badge.fury.io/py/himawari_api.svg)](https://badge.fury.io/py/himawari_api)
[![Conda Version](https://img.shields.io/conda/vn/conda-forge/himawari_api.svg)](https://anaconda.org/conda-forge/goes_api)
[![Build Status](https://github.com/ghiggi/himawari_api/workflows/Continuous%20Integration/badge.svg?branch=main)](https://github.com/ghiggi/himawari_api/actions)
[![Coverage Status](https://coveralls.io/repos/github/ghiggi/himawari_api/badge.svg?branch=main)](https://coveralls.io/github/ghiggi/himawari_api?branch=main)
[![Documentation Status](https://readthedocs.org/projects/himawari_api/badge/?version=latest)](https://gpm_api.readthedocs.io/projects/himawari_api/en/stable/?badge=stable)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)
[![License](https://img.shields.io/github/license/ghiggi/himawari_api)](https://github.com/ghiggi/himawari_api/blob/master/LICENSE)

The HIMAWARI-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 HIMAWARI-8 and HIMAWARI-9 satellite data.

Data download and query/filtering is available:
- for local file systems and AWS S3.
- for sensors AHI.

The folder `tutorials` provide the following jupyter notebooks, describing various features of `HIMAWARI_API`:

- Downloading HIMAWARI data: [`download.ipynb`]
- Find and filter HIMAWARI data: [`find_and_filter.ipynb`]
- Read AHI and plot it with satpy: [`read_ahi_data.ipynb`]
 
[`download.ipynb`]: https://github.com/ghiggi/himawari_api/blob/main/tutorials/00_download_and_find_files.py
[`find_and_filter.ipynb`]: https://github.com/ghiggi/himawari_api/blob/main/tutorials/01_find_utility.py
[`read_ahi_data.ipynb`]: https://github.com/ghiggi/himawari_api/blob/main/tutorials/03_read_ahi_rad_data_with_satpy.py

Documentation is available at XXXXX

## Installation

### pip

HIMAWARI-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 HIMAWARI-API package by typing the following command in the command terminal:

    pip install himawari_api

## Citation

If you are using HIMAWARI-API, please cite:

> Ghiggi Gionata. ghiggi/himawari_api. Zenodo. https://doi.org/10.5281/zenodo.7787923

If you want to cite a specific version, have a look at the [Zenodo site](https://doi.org/10.5281/zenodo.7787923).

## 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": "himawari-api",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": "",
    "keywords": "Himawari-8,Himawari-9,AHI,satellite,weather,meteorology,forecasting,EWS",
    "author": "",
    "author_email": "Gionata Ghiggi <gionata.ghiggi@epfl.ch>",
    "download_url": "https://files.pythonhosted.org/packages/97/8c/75a562211008535b33d0c062d535abc9f34da830a00f55ea46fcd2032dab/himawari_api-0.0.2.tar.gz",
    "platform": null,
    "description": "# Welcome to HIMAWARI API - An API to download and search HIMAWARI satellite data.\n[![DOI](https://zenodo.org/badge/538957326.svg)](https://zenodo.org/badge/latestdoi/538957326)\n[![PyPI version](https://badge.fury.io/py/himawari_api.svg)](https://badge.fury.io/py/himawari_api)\n[![Conda Version](https://img.shields.io/conda/vn/conda-forge/himawari_api.svg)](https://anaconda.org/conda-forge/goes_api)\n[![Build Status](https://github.com/ghiggi/himawari_api/workflows/Continuous%20Integration/badge.svg?branch=main)](https://github.com/ghiggi/himawari_api/actions)\n[![Coverage Status](https://coveralls.io/repos/github/ghiggi/himawari_api/badge.svg?branch=main)](https://coveralls.io/github/ghiggi/himawari_api?branch=main)\n[![Documentation Status](https://readthedocs.org/projects/himawari_api/badge/?version=latest)](https://gpm_api.readthedocs.io/projects/himawari_api/en/stable/?badge=stable)\n[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)\n[![License](https://img.shields.io/github/license/ghiggi/himawari_api)](https://github.com/ghiggi/himawari_api/blob/master/LICENSE)\n\nThe HIMAWARI-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 HIMAWARI-8 and HIMAWARI-9 satellite data.\n\nData download and query/filtering is available:\n- for local file systems and AWS S3.\n- for sensors AHI.\n\nThe folder `tutorials` provide the following jupyter notebooks, describing various features of `HIMAWARI_API`:\n\n- Downloading HIMAWARI data: [`download.ipynb`]\n- Find and filter HIMAWARI data: [`find_and_filter.ipynb`]\n- Read AHI and plot it with satpy: [`read_ahi_data.ipynb`]\n \n[`download.ipynb`]: https://github.com/ghiggi/himawari_api/blob/main/tutorials/00_download_and_find_files.py\n[`find_and_filter.ipynb`]: https://github.com/ghiggi/himawari_api/blob/main/tutorials/01_find_utility.py\n[`read_ahi_data.ipynb`]: https://github.com/ghiggi/himawari_api/blob/main/tutorials/03_read_ahi_rad_data_with_satpy.py\n\nDocumentation is available at XXXXX\n\n## Installation\n\n### pip\n\nHIMAWARI-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 HIMAWARI-API package by typing the following command in the command terminal:\n\n    pip install himawari_api\n\n## Citation\n\nIf you are using HIMAWARI-API, please cite:\n\n> Ghiggi Gionata. ghiggi/himawari_api. Zenodo. https://doi.org/10.5281/zenodo.7787923\n\nIf you want to cite a specific version, have a look at the [Zenodo site](https://doi.org/10.5281/zenodo.7787923).\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 Himawari satellite data on local and cloud storage.",
    "version": "0.0.2",
    "split_keywords": [
        "himawari-8",
        "himawari-9",
        "ahi",
        "satellite",
        "weather",
        "meteorology",
        "forecasting",
        "ews"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "a21c7d7c216d906e3f6bbce1d58cd06135b6afe2c577c4510123caf67a7f174b",
                "md5": "5af3146a1d52f4db6b73c5da2a531c05",
                "sha256": "9582bd4ccffb176ba2e4912f16f8c7a678e9259c2d0c0ec549821b86451de4f4"
            },
            "downloads": -1,
            "filename": "himawari_api-0.0.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "5af3146a1d52f4db6b73c5da2a531c05",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 33829,
            "upload_time": "2023-03-31T08:07:34",
            "upload_time_iso_8601": "2023-03-31T08:07:34.113791Z",
            "url": "https://files.pythonhosted.org/packages/a2/1c/7d7c216d906e3f6bbce1d58cd06135b6afe2c577c4510123caf67a7f174b/himawari_api-0.0.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "978c75a562211008535b33d0c062d535abc9f34da830a00f55ea46fcd2032dab",
                "md5": "f0c647c297849c88de63c4eb107404e0",
                "sha256": "8f49e263fa5eaf2b892a114721fed14de8165f0ba3d060b2ea62775fe89fba06"
            },
            "downloads": -1,
            "filename": "himawari_api-0.0.2.tar.gz",
            "has_sig": false,
            "md5_digest": "f0c647c297849c88de63c4eb107404e0",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 30649,
            "upload_time": "2023-03-31T08:07:35",
            "upload_time_iso_8601": "2023-03-31T08:07:35.401545Z",
            "url": "https://files.pythonhosted.org/packages/97/8c/75a562211008535b33d0c062d535abc9f34da830a00f55ea46fcd2032dab/himawari_api-0.0.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-03-31 08:07:35",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "lcname": "himawari-api"
}
        
Elapsed time: 0.05296s