Skip to content

cityjson/city3d-stac-registry

Repository files navigation

City3D STAC Open Data Registry

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

Repository Layout

.
├── catalog/
│   └── catalog-config.yaml
├── collections/
│   └── *.yaml
├── manifests/
│   └── *_urls.txt
├── docs/
├── city3d-stac-tool/
└── .github/workflows/

Map viewer

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/.

City3d STAC map

Local Usage

Initialize submodules first:

git submodule update --init --recursive

Install the CLI as a native binary with Cargo:

cargo install --git ssh://git@github.com/HideBa/city3d-stac-tool.git --bin city3dstac

Validate a collection config:

cargo run --manifest-path city3d-stac-tool/Cargo.toml -- \
  collection --config collections/rotterdam-config.yaml --dry-run

Validate the catalog config:

cargo run --manifest-path city3d-stac-tool/Cargo.toml -- \
  catalog --config catalog/catalog-config.yaml --dry-run

Generate the published catalog locally:

cargo run --manifest-path city3d-stac-tool/Cargo.toml -- \
  catalog --config catalog/catalog-config.yaml -o build/site

Rebuild collection metadata from existing generated item JSON files, without downloading or regenerating items:

scripts/generate-catalog.sh --collections-only

Use 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.

Contribution Model

  • Add or update dataset definitions in collections/.
  • Update catalog/catalog-config.yaml when 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.

About

A registry for City3D STAC catalog

Topics

Resources

License

Contributing

Stars

3 stars

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors