# stactools-goes-glm
[](https://pypi.org/project/stactools-goes-glm/)
- Name: goes-glm
- Package: `stactools.goes_glm`
- PyPI: <https://pypi.org/project/stactools-goes-glm/>
- Owner: @m-mohr
- Dataset homepage:
- <https://www.goes-r.gov/spacesegment/glm.html>
- <https://ghrc.nsstc.nasa.gov/lightning/overview_glm.html>
- STAC extensions used:
- [datacube](https://github.com/stac-extensions/datacube/) (for netCDF only)
- [GOES](https://github.com/stac-extensions/goes/)
- [processing](https://github.com/stac-extensions/processing/)
- [proj](https://github.com/stac-extensions/projection/)
- [table](https://github.com/stac-extensions/table/) (for geoparquet only)
- Extra fields:
- Prefix `goes:`: As defined in the [GOES extension](https://github.com/stac-extensions/goes/).
All variables with valid scalar values / without dimensions are added to
the Item properties with a `goes:` prefix. The variable name is used as
the property key after the prefix, e.g. `goes:event_count`.
A stactools package for the Geostationary Lightning Mapper (GLM) dataset, which
is on the GOES-16/R, GOES-17/S, and GOES-18/T satellites. GLM detects all forms
of lightning during both day and night, continuously, with a high spatial
resolution and detection efficiency.
This package can generate STAC files from netCDF files and that either link to
the original netCDF files or to geoparquet files.
## STAC Examples
- [Collection](examples/collection.json)
- [Item (GOES-16/R)](./examples/OR_GLM-L2-LCFA_G16_s20181591447400_e20181591448000/OR_GLM-L2-LCFA_G16_s20181591447400_e20181591448000.json)
- [Item (GOES-17/S)](./examples/OR_GLM-L2-LCFA_G17_s20200160612000_e20200160612110/OR_GLM-L2-LCFA_G17_s20200160612000_e20200160612110.json)
- [Item (GOES-17/S (Test) before drifting to the final location)](./examples/OR_GLM-L2-LCFA_G17_s20182831047000_e20182831047200/OR_GLM-L2-LCFA_G17_s20182831047000_e20182831047200.json)
- [Item (GOES-18/T)](./examples/OR_GLM-L2-LCFA_G18_s20230261900000_e20230261900200/OR_GLM-L2-LCFA_G18_s20230261900000_e20230261900200.json)
- [Browse the example in a human-readable form](https://radiantearth.github.io/stac-browser/#/external/raw.githubusercontent.com/stactools-packages/goes-glm/main/examples/collection.json)
## Installation
```shell
pip install stactools-goes-glm
```
## Command-line Usage
Use `stac goes-glm --help` to see all subcommands and options.
### Collection
Create a collection:
```shell
stac goes-glm create-collection collection.json --license=https://www.ncei.noaa.gov/access/metadata/landing-page/bin/iso?id=gov.noaa.ncdc:C01527
```
Get information about all options for collection creation:
```shell
stac goes-glm create-collection --help
```
### Item
Create an item with a netCDF and multiple geoparquet asset:
```shell
stac goes-glm create-item OR_GLM-L2-LCFA_G16_s20203662359400_e20210010000004_c20210010000030.nc item.json --collection collection.json
```
Create an item with only geoparquet assets:
```shell
stac goes-glm create-item OR_GLM-L2-LCFA_G17_s20221542100000_e20221542100200_c20221542100217.nc item.json --collection collection.json --nonetcdf TRUE
```
Get information about all options for item creation:
```shell
stac goes-glm create-item --help
```
## Contributing
We use [pre-commit](https://pre-commit.com/) to check any changes.
To set up your development environment:
```shell
pip install -e .
pip install -r requirements-dev.txt
pre-commit install
```
To check all files:
```shell
pre-commit run --all-files
```
To run the tests:
```shell
pytest -vv
```
Raw data
{
"_id": null,
"home_page": "https://github.com/stactools-packages/goes-glm",
"name": "stactools-goes-glm",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "stactools,goes,glm,lightning,STAC",
"author": "Matthias Mohr",
"author_email": "matthias.mohr@radiant.earth",
"download_url": "https://files.pythonhosted.org/packages/52/98/3ffdd56fac551d1568b460f2d169e8f00e1968f79a07d973c521859344f6/stactools-goes-glm-0.2.3.tar.gz",
"platform": null,
"description": "# stactools-goes-glm\n\n[](https://pypi.org/project/stactools-goes-glm/)\n\n- Name: goes-glm\n- Package: `stactools.goes_glm`\n- PyPI: <https://pypi.org/project/stactools-goes-glm/>\n- Owner: @m-mohr\n- Dataset homepage:\n - <https://www.goes-r.gov/spacesegment/glm.html>\n - <https://ghrc.nsstc.nasa.gov/lightning/overview_glm.html>\n- STAC extensions used:\n - [datacube](https://github.com/stac-extensions/datacube/) (for netCDF only)\n - [GOES](https://github.com/stac-extensions/goes/)\n - [processing](https://github.com/stac-extensions/processing/)\n - [proj](https://github.com/stac-extensions/projection/)\n - [table](https://github.com/stac-extensions/table/) (for geoparquet only)\n- Extra fields:\n - Prefix `goes:`: As defined in the [GOES extension](https://github.com/stac-extensions/goes/).\n All variables with valid scalar values / without dimensions are added to\n the Item properties with a `goes:` prefix. The variable name is used as\n the property key after the prefix, e.g. `goes:event_count`.\n\nA stactools package for the Geostationary Lightning Mapper (GLM) dataset, which\nis on the GOES-16/R, GOES-17/S, and GOES-18/T satellites. GLM detects all forms\nof lightning during both day and night, continuously, with a high spatial\nresolution and detection efficiency.\n\nThis package can generate STAC files from netCDF files and that either link to\nthe original netCDF files or to geoparquet files.\n\n## STAC Examples\n\n- [Collection](examples/collection.json)\n- [Item (GOES-16/R)](./examples/OR_GLM-L2-LCFA_G16_s20181591447400_e20181591448000/OR_GLM-L2-LCFA_G16_s20181591447400_e20181591448000.json)\n- [Item (GOES-17/S)](./examples/OR_GLM-L2-LCFA_G17_s20200160612000_e20200160612110/OR_GLM-L2-LCFA_G17_s20200160612000_e20200160612110.json)\n- [Item (GOES-17/S (Test) before drifting to the final location)](./examples/OR_GLM-L2-LCFA_G17_s20182831047000_e20182831047200/OR_GLM-L2-LCFA_G17_s20182831047000_e20182831047200.json)\n- [Item (GOES-18/T)](./examples/OR_GLM-L2-LCFA_G18_s20230261900000_e20230261900200/OR_GLM-L2-LCFA_G18_s20230261900000_e20230261900200.json)\n- [Browse the example in a human-readable form](https://radiantearth.github.io/stac-browser/#/external/raw.githubusercontent.com/stactools-packages/goes-glm/main/examples/collection.json)\n\n## Installation\n\n```shell\npip install stactools-goes-glm\n```\n\n## Command-line Usage\n\nUse `stac goes-glm --help` to see all subcommands and options.\n\n### Collection\n\nCreate a collection:\n\n```shell\nstac goes-glm create-collection collection.json --license=https://www.ncei.noaa.gov/access/metadata/landing-page/bin/iso?id=gov.noaa.ncdc:C01527\n```\n\nGet information about all options for collection creation:\n\n```shell\nstac goes-glm create-collection --help\n```\n\n### Item\n\nCreate an item with a netCDF and multiple geoparquet asset:\n\n```shell\nstac goes-glm create-item OR_GLM-L2-LCFA_G16_s20203662359400_e20210010000004_c20210010000030.nc item.json --collection collection.json\n```\n\nCreate an item with only geoparquet assets:\n\n```shell\nstac goes-glm create-item OR_GLM-L2-LCFA_G17_s20221542100000_e20221542100200_c20221542100217.nc item.json --collection collection.json --nonetcdf TRUE\n```\n\nGet information about all options for item creation:\n\n```shell\nstac goes-glm create-item --help\n```\n\n## Contributing\n\nWe use [pre-commit](https://pre-commit.com/) to check any changes.\nTo set up your development environment:\n\n```shell\npip install -e .\npip install -r requirements-dev.txt\npre-commit install\n```\n\nTo check all files:\n\n```shell\npre-commit run --all-files\n```\n\nTo run the tests:\n\n```shell\npytest -vv\n```\n",
"bugtrack_url": null,
"license": "",
"summary": "stactools package for the Geostationary Lightning Mapper (GLM) on the GOES-16/R, GOES-17/S, and GOES-18/T satellites.",
"version": "0.2.3",
"split_keywords": [
"stactools",
"goes",
"glm",
"lightning",
"stac"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "99c8b2aac9c73bff73789ef14ac1605524074c0cab335aa42f509e5f15ad090e",
"md5": "fd65521ed7e751cb9f20027abc5cf225",
"sha256": "8adad77557600221772fb374fec64670fd4c55b1e55a151aa965c699dd61740f"
},
"downloads": -1,
"filename": "stactools_goes_glm-0.2.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "fd65521ed7e751cb9f20027abc5cf225",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 14972,
"upload_time": "2023-01-27T16:30:38",
"upload_time_iso_8601": "2023-01-27T16:30:38.874678Z",
"url": "https://files.pythonhosted.org/packages/99/c8/b2aac9c73bff73789ef14ac1605524074c0cab335aa42f509e5f15ad090e/stactools_goes_glm-0.2.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "52983ffdd56fac551d1568b460f2d169e8f00e1968f79a07d973c521859344f6",
"md5": "7d94f38649ba81f9e7eeb17f3865c650",
"sha256": "3552b30b9c3e118039fd8ca50a0d02771a11b8a45f4c662478045a745006ba31"
},
"downloads": -1,
"filename": "stactools-goes-glm-0.2.3.tar.gz",
"has_sig": false,
"md5_digest": "7d94f38649ba81f9e7eeb17f3865c650",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 13756,
"upload_time": "2023-01-27T16:30:40",
"upload_time_iso_8601": "2023-01-27T16:30:40.983551Z",
"url": "https://files.pythonhosted.org/packages/52/98/3ffdd56fac551d1568b460f2d169e8f00e1968f79a07d973c521859344f6/stactools-goes-glm-0.2.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-27 16:30:40",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "stactools-packages",
"github_project": "goes-glm",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "stactools-goes-glm"
}
JSON
