Public registry of 3D city model dataset definitions used to generate STAC catalogs, collections, and items.
This repository is separate from the generator implementation. The CLI lives in the
city3d-stac-tool git submodule, which points to git@github.com:HideBa/city3d-stac-tool.git.
Canonical registry repository:
https://github.com/cityjson/city3d-stac-registry
.
├── catalog/
│ └── catalog-config.yaml
├── collections/
│ └── *.yaml
├── manifests/
│ └── *_urls.txt
├── docs/
├── city3d-stac-tool/
└── .github/workflows/
Config files registered in this repository automatically generate STAC catalogs, collections, and items. The generated STAC assets can be previewed on https://cityjson.github.io/city3d-stac-map/.
Initialize submodules first:
git submodule update --init --recursiveInstall the CLI as a native binary with Cargo:
cargo install --git ssh://git@github.com/HideBa/city3d-stac-tool.git --bin city3dstacValidate a collection config:
cargo run --manifest-path city3d-stac-tool/Cargo.toml -- \
collection --config collections/rotterdam-config.yaml --dry-runValidate the catalog config:
cargo run --manifest-path city3d-stac-tool/Cargo.toml -- \
catalog --config catalog/catalog-config.yaml --dry-runGenerate the published catalog locally:
cargo run --manifest-path city3d-stac-tool/Cargo.toml -- \
catalog --config catalog/catalog-config.yaml -o build/siteRebuild collection metadata from existing generated item JSON files, without downloading or regenerating items:
scripts/generate-catalog.sh --collections-onlyUse a collection config stem to rebuild one collection, for example
scripts/generate-catalog.sh --collections-only japan-plateau. Rebuild the
root catalog afterwards with scripts/generate-catalog.sh --catalog-only.
- Add or update dataset definitions in
collections/. - Update
catalog/catalog-config.yamlwhen a dataset should appear in the published catalog. - Keep generated STAC JSON out of git; CI publishes it from the source configs.
- Commit supporting URL manifests in
manifests/when a dataset is too large to maintain inline.
See CONTRIBUTING.md and docs/publishing.md.
