stactools-packages / noaa-mrms-qpe

stactools package for NOAA's Multi-Radar Multi-Sensor Quantitative Precipitation Estimation dataset
Other
2 stars 1 forks source link
mrms noaa qpe stac stactools

stactools-noaa-mrms-qpe

PyPI

A stactools package for NOAA's Multi-Radar Multi-Sensor (MRMS) Quantitative Precipitation Estimation (QPE) dataset.

This package can generate STAC files from (gzipped) GRIB2 files that link to the original GRIB2 files and/or to Cloud-Optimized GeoTiffs (COGs) in the original or any other EPSG projection.

STAC Examples

Installation

pip install stactools-noaa-mrms-qpe

Command-line Usage

Collection

Create a collection, e.g. 24-hour Pass 2:

stac noaa-mrms-qpe create-collection collection.json --period 24 --pass_no 2

Get information about all options for collection creation:

stac noaa-mrms-qpe create-collection --help

Item

Create an item for continentel US with a GRIB2 and COG asset:

stac noaa-mrms-qpe create-item MRMS_MultiSensor_QPE_24H_Pass2_00.00_20220530-120000.grib2.gz item_grib.json --collection collection.json

Create an item for ALASKA with only a COG asset converted to EPSG:3857:

stac noaa-mrms-qpe create-item MRMS_MultiSensor_QPE_24H_Pass2_00.00_20220530-120000.grib2.gz item.json --aoi ALASKA --collection collection.json --nogrib TRUE --epsg 3857

Get information about all options for item creation:

stac noaa-mrms-qpe create-item --help

Use stac noaa-mrms-qpe --help to see all subcommands and options.

Note: This package can only read files that contain the timestamp in the file name. It can NOT read the files that contain latest instead of a timestamp in the file name.

Contributing

We use pre-commit to check any changes. To set up your development environment:

$ pip install -e .
$ pip install -r requirements-dev.txt
$ pre-commit install

To check all files:

$ pre-commit run --all-files

To run the tests:

$ pytest -vv