stactools-modis

• Name: modis
• Package: 'stactools.modis'
• PyPI: https://pypi.org/project/stactools-modis/
• Owner: @gadomski
• Dataset homepage: https://modis.gsfc.nasa.gov/
• STAC extensions used:
  • classification
  • eo
  • item-assets
  • proj
  • raster
  • scientific
• Extra Fields:
  • modis:horizontal-tile
  • modis:vertical-tile
  • modis:tile-id

This repository will assist you in the generation of STAC files for MODIS datasets.

Examples

There is an example Catalog at examples/catalog.json. Inside that catalog are several MODIS v6.0 and v6.1 STAC Collections and Items.

Command-line Usage

To create a STAC Item:

$ stac modis create-item tests/data-files/MCD12Q1.A2001001.h00v08.006.2018142182903.hdf.xml build

To create a STAC Catalog from a list of MODIS asset hrefs:

$ stac modis create-catalog examples/file-list-061.txt examples/modis-061

Contributing

If you are making any changes to the item or collection structure, the tests will fail until you update the expected values. To update, run this script:

$ scripts/create_expected.py

This will create, validate, and save new test data items into tests/data-files/expected which are used for unit testing.

Once you've got a pull request ready, please update the examples as well (you'll need to download the external test data files first, see below):

$ stac modis create-catalog --cogify examples/file-list-061.txt examples/modis-061

Note that this will take a while (~5-10 minutes). If you need to update the examples later, you can omit the --cogify as the COGs will already be created.

Running tests

Because of the large number of MODIS products supported by this library and their asset file size, the default test suite does not download all HDF files. To run all tests, use the --runslow option for pytest:

pytest --runslow

This will download HDF files for all 061 products to tests/data-files/external. Note that these files are required to create the examples/ directory.