# stactools-global-mangrove-watch
[](https://pypi.org/project/stactools-global-mangrove-watch/)

- Name: global-mangrove-watch
- Package: `stactools.global_mangrove_watch`
- [stactools-global-mangrove-watch on PyPI](https://pypi.org/project/stactools-global-mangrove-watch/)
- Owner: @hrodmn
- [Dataset homepage](https://zenodo.org/records/6894273)
- STAC extensions used:
- [proj](https://github.com/stac-extensions/projection/)
- [version](https://github.com/stac-extensions/version/)
- [scientific](https://github.com/stac-extensions/scientific/)
- [render](https://github.com/stac-extensions/render/)
- [Browse the example in human-readable form](https://radiantearth.github.io/stac-browser/#/external/raw.githubusercontent.com/stactools-packages/global-mangrove-watch/main/examples/collection.json)
- [Browse a notebook demonstrating the example item and collection](https://github.com/stactools-packages/global-mangrove-watch/tree/main/docs/example.ipynb)
This package can be used to generate STAC metadata for the [Global Mangrove Watch Dataset](https://zenodo.org/records/6894273).
## Details
- It is assumed that the raw files have been downloaded from the source and unzipped in a persistent storage location in order to provide proper `hrefs` for the STAC assets.
- Each item represents a particular year (1996, 2007, 2008, etc) with assets for the annual mangrove mask raster (`cog`) and the 1996-`{year}` change raster (`change_cog`).
- The vector files are not yet added as assets
## STAC examples
- [Collection](examples/collection.json)
- [Item](examples/item/item.json)
## Installation
```shell
pip install stactools-global-mangrove-watch
```
## Command-line usage
Create a collection json:
```shell
stac global-mangrove-watch create-collection {destination}
```
Create an item json:
```shell
stac global-mangrove-watch create-item {cog_asset_href} {destination}
```
Use `stac global-mangrove-watch --help` to see all subcommands and options.
## Contributing
We use [pre-commit](https://pre-commit.com/) to check any changes.
To set up your development environment:
```shell
uv sync
uv run pre-commit install
```
To check all files:
```shell
uv run pre-commit run --all-files
```
To run the tests:
```shell
uv run pytest -vv
```
If you've updated the STAC metadata output, update the examples:
```shell
uv run scripts/update-examples
```
Raw data
{
"_id": null,
"home_page": null,
"name": "stactools-global-mangrove-watch",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "Henry Rodman <henry@developmentseed.org>",
"keywords": "stactools, pystac, catalog, STAC, mangrove",
"author": null,
"author_email": "Henry Rodman <henry@developmentseed.org>",
"download_url": "https://files.pythonhosted.org/packages/6d/6c/8fa51fcf3efb359320d684c298b3a8598ab8ef3d4baeb1d093ae4b4b270b/stactools_global_mangrove_watch-0.2.1.tar.gz",
"platform": null,
"description": "# stactools-global-mangrove-watch\n\n[](https://pypi.org/project/stactools-global-mangrove-watch/)\n\n\n- Name: global-mangrove-watch\n- Package: `stactools.global_mangrove_watch`\n- [stactools-global-mangrove-watch on PyPI](https://pypi.org/project/stactools-global-mangrove-watch/)\n- Owner: @hrodmn\n- [Dataset homepage](https://zenodo.org/records/6894273)\n- STAC extensions used:\n - [proj](https://github.com/stac-extensions/projection/)\n - [version](https://github.com/stac-extensions/version/)\n - [scientific](https://github.com/stac-extensions/scientific/)\n - [render](https://github.com/stac-extensions/render/)\n- [Browse the example in human-readable form](https://radiantearth.github.io/stac-browser/#/external/raw.githubusercontent.com/stactools-packages/global-mangrove-watch/main/examples/collection.json)\n- [Browse a notebook demonstrating the example item and collection](https://github.com/stactools-packages/global-mangrove-watch/tree/main/docs/example.ipynb)\n\nThis package can be used to generate STAC metadata for the [Global Mangrove Watch Dataset](https://zenodo.org/records/6894273).\n\n## Details\n\n- It is assumed that the raw files have been downloaded from the source and unzipped in a persistent storage location in order to provide proper `hrefs` for the STAC assets.\n- Each item represents a particular year (1996, 2007, 2008, etc) with assets for the annual mangrove mask raster (`cog`) and the 1996-`{year}` change raster (`change_cog`).\n - The vector files are not yet added as assets\n\n## STAC examples\n\n- [Collection](examples/collection.json)\n- [Item](examples/item/item.json)\n\n## Installation\n\n```shell\npip install stactools-global-mangrove-watch\n```\n\n## Command-line usage\n\nCreate a collection json:\n\n```shell\nstac global-mangrove-watch create-collection {destination}\n```\n\nCreate an item json:\n\n```shell\nstac global-mangrove-watch create-item {cog_asset_href} {destination}\n```\n\nUse `stac global-mangrove-watch --help` to see all subcommands and options.\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\nuv sync\nuv run pre-commit install\n```\n\nTo check all files:\n\n```shell\nuv run pre-commit run --all-files\n```\n\nTo run the tests:\n\n```shell\nuv run pytest -vv\n```\n\nIf you've updated the STAC metadata output, update the examples:\n\n```shell\nuv run scripts/update-examples\n```\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "A stactools package for the Global Mangrove Watch dataset",
"version": "0.2.1",
"project_urls": {
"Github": "https://github.com/stactools-packages/global-mangrove-watch",
"Issues": "https://github.com/stactools-packages/global-mangrove-watch/issues"
},
"split_keywords": [
"stactools",
" pystac",
" catalog",
" stac",
" mangrove"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "4421d2d7e12ebb5c6256203bda7a39e9d340caa54ffd2c62de11b6738dbb4bbd",
"md5": "28ff8d75e12cd6ce050c583ccabd0c68",
"sha256": "2bc98a3fa543dadf9ae867a9ab1fe652f20ffbf6c1e9be367572850c826f0cf5"
},
"downloads": -1,
"filename": "stactools_global_mangrove_watch-0.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "28ff8d75e12cd6ce050c583ccabd0c68",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 8713,
"upload_time": "2025-02-12T20:09:08",
"upload_time_iso_8601": "2025-02-12T20:09:08.431582Z",
"url": "https://files.pythonhosted.org/packages/44/21/d2d7e12ebb5c6256203bda7a39e9d340caa54ffd2c62de11b6738dbb4bbd/stactools_global_mangrove_watch-0.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "6d6c8fa51fcf3efb359320d684c298b3a8598ab8ef3d4baeb1d093ae4b4b270b",
"md5": "4dac473c3dfe88497b94e9c7410236ab",
"sha256": "86cd45f01c702cfd8e4b2c157ee23733b75dbd76e586b8a6bd8a51843bf6a24a"
},
"downloads": -1,
"filename": "stactools_global_mangrove_watch-0.2.1.tar.gz",
"has_sig": false,
"md5_digest": "4dac473c3dfe88497b94e9c7410236ab",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 9431,
"upload_time": "2025-02-12T20:09:09",
"upload_time_iso_8601": "2025-02-12T20:09:09.745201Z",
"url": "https://files.pythonhosted.org/packages/6d/6c/8fa51fcf3efb359320d684c298b3a8598ab8ef3d4baeb1d093ae4b4b270b/stactools_global_mangrove_watch-0.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-12 20:09:09",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "stactools-packages",
"github_project": "global-mangrove-watch",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "stactools-global-mangrove-watch"
}