eopf-stac

Python tool to create STAC metadata for an EOPF product.

When started, it does the following:

• Opens the EOPF product from a given URL and validates it.
• Creates a STAC item with assets. The assets href is based on the given URL.
• Adds the STAC item to a STAC catalog. If an item with the same id already exists, it will be updated.

Installation

Install the package using pip:

# Install from source
pip install .

# Or install in editable mode for development
pip install -e .

After installation, the eopf-stac command will be available in your environment.

Usage

The EOPF product must be referenced by an URL which must be provided as a command-line argument. Only http(s)://, s3:// and file:// URLs are supported. For debugging, a combination of the --dry-run and --debug option can be used to see the created STAC item in the logs without inserting it into a catalog.

$ eopf-stac --help
usage: eopf-stac.py [-h] [--source-uri SOURCE_URI] [--dry-run] [--output-file OUTPUT_FILE] [--debug] URL

positional arguments:
  URL         Local file path or URL to the EOPF product

options:
  -h, --help            show this help message and exit
  --source-uri SOURCE_URI
                        Reference to the original product which was input for the EOPF conversion
  --dry-run             Create STAC item without trying to insert it into the catalog
  --output-file OUTPUT_FILE
                        Save the STAC item as JSON to the specified file path
  --debug               Enable verbose output

Example usage:

# Register STAC item to catalog
eopf-stac s3://path/to/eopf.zarr

# Save STAC item to local file instead of registering
eopf-stac --output-file item.json s3://path/to/eopf.zarr

# Dry run with debug output (only logs, doesn't save or register)
eopf-stac --dry-run --debug s3://path/to/eopf.zarr

# With source URI
eopf-stac --source-uri s3://original/product.nc s3://path/to/eopf.zarr

Settings

Additional settings need to be provided through the following environment variables:

Variable	Description	Default
AWS_ACCESS_KEY_ID	If an s3 URL is provided, the access key for the object storage where the EOPF product is stored.	None
AWS_SECRET_ACCESS_KEY	If an s3 URL is provided, the secret for the access key.	None
S3_ENDPOINT_URL	If an s3 URL is provided, the endpoint URL of the object storage	None
STAC_API_URL	The URL of the STAC catalog to register the created STAC item. Not required if --output-file is used.	None
STAC_INGEST_USER	The username to access the transaction endpoints of the STAC API with HTTP Basic Auth	None
STAC_INGEST_PASS	The password to access the transaction endpoints of the STAC API with HTTP Basic Auth	None

Docker

The tool can also be exectued with Docker. Images are available at the Github container registry. It can be run as follows:

$ docker run \
    --env AWS_ACCESS_KEY_ID=value \
    --env AWS_SECRET_ACCESS_KEY=value \
    --env S3_ENDPOINT_URL=value \
    --env STAC_API_URL=value \
    --env STAC_INGEST_USER=value \
    --env STAC_INGEST_PASS=value \
    ghcr.io/eopf-sample-service/eopf-stac:0.12.0 s3://path/to/eopf.zarr