Restore+ STAC

Utility package to create STAC Static for the Restore+ Project.

Getting started

To get started and create a STAC Static, first install the package:

# install.packages("pak")
pak::pak("restore-plus/restore-stac")

Next, open the R and load the configurations:

config <- restorestac::config_from_env()

Then, generate the STAC and synchronize with the S3 bucket:

restorestac::sync(
    settings            = config,
    catalog_id          = "restore-plus",
    catalog_title       = "Restore+ Data catalog",
    catalog_description = "Catalog centralizing maps for the Restore+ Project",
    output_prefix       = "stac"
)

Configuration

All settings come from environment variables (a local .env file is loaded automatically if present. Check the .env.example):

Variable	Required	Description
AWS_S3_BUCKET	Yes	S3 bucket name
AWS_S3_REGION	No	AWS region (default: us-east-1)
AWS_S3_ENDPOINT_URL	No	Custom S3 endpoint
AWS_S3_COLLECTION_PATHS	Yes	Comma-separated S3 collection paths
AWS_ACCESS_KEY_ID	No	AWS access key ID
AWS_SECRET_ACCESS_KEY	No	AWS secret access key
AWS_SESSION_TOKEN	No	AWS session token (temporary credentials)

Note: When AWS_ACCESS_KEY_ID / AWS_SECRET_ACCESS_KEY are set, they are passed explicitly to the S3 client. Otherwise, the default AWS credential chain is used (profiles, IAM roles).

Contributing

Contributions are welcome! If you have an example that you’d like to share, please submit a pull request. Make sure your example is well-documented and includes all necessary data and scripts.

License

The source code in this repository is licensed under GNU GENERAL PUBLIC LICENSE V3. Data and results are under the Creative Commons CC BY-NC-SA 4.0 License.

Contact

For questions or suggestions, please open an issue or contact the repository maintainers.

---