# Attribution

This repository contains code, documentation, and (optionally) processed geodata for an academic digital twin / flood-visualization prototype of the city of Trier (Germany).

Please keep this file with any redistribution of the repository or any exported builds that include the referenced datasets.

---

## Primary geodata sources

### Landesamt für Vermessung und Geobasisinformation Rheinland-Pfalz (LVermGeo RLP)
**Data used (depending on project configuration):**
- Digitales Geländemodell (DGM) / DGM1 (GeoTIFF)
- Digitale Orthophotos (DOP), e.g. DOP20
- 3D-Gebäudemodelle (CityGML, LOD1/LOD2)

**Provider:** Landesamt für Vermessung und Geobasisinformation Rheinland-Pfalz (LVermGeo RLP)  
**License:** Datenlizenz Deutschland – Namensnennung – Version 2.0 (dl-de/by-2-0)  
**Attribution:** © LVermGeo Rheinland-Pfalz (dl-de/by-2-0)  
**Accessed:** 2025-12-13

Notes:
- The repository may include derived products (e.g., heightmaps, texture tiles, meshes) generated from LVermGeo datasets. These derivatives remain subject to the original attribution requirements.
- The download helper (`scripts/dlscript_dop20.sh`) builds a trust chain to `geobasis-rlp.de`; ensure CA handling complies with your environment’s security policies.

---

## Optional / supplemental sources

### OpenStreetMap
**Data used (optional):**
- Building footprints and tags (heights/levels where available)
- Roads, rivers, landuse, points of interest

**Provider:** OpenStreetMap contributors  
**License:** Open Database License (ODbL)  
**Attribution:** © OpenStreetMap contributors (ODbL)  
**Accessed:** YYYY-MM-DD (fill in)

Notes:
- If you redistribute derived databases or extracts in a way that triggers ODbL share-alike requirements, ensure compliance with ODbL terms (including attribution and, where applicable, sharing derivative databases under ODbL).

---

## Hydrology / water level data (optional)

### PEGELONLINE (WSV)
**Data used (optional):**
- River gauge measurements (water levels), accessed via PEGELONLINE API

**Provider:** Wasserstraßen- und Schifffahrtsverwaltung des Bundes (WSV), PEGELONLINE  
**Attribution:** Data source: PEGELONLINE (WSV)  
**Accessed:** YYYY-MM-DD (fill in)

Notes:
- Ensure you follow PEGELONLINE’s published terms and attribution requirements for your specific usage and redistribution context.

---

## Software and tooling

- **GDAL** (core dependency, MIT/X-style license). Used for VRT creation, warping, scaling, and raster translation in the Python pipeline.
- **cjio** (Python dependency, MIT license). Included for CityJSON tooling; not all commands are wired into the main pipeline yet.
- **citygml-tools 2.4.0** (bundled under `citygml-tools-2.4.0/`, Apache License 2.0). Java CLI utilities for future CityGML/CityJSON conversion experiments.

Retain upstream license files when redistributing these tools or building derivative artifacts that embed them.

---

## Project authorship (this repository)
All original code, scripts, and documentation authored by the project team are licensed under the repository’s main license (see `LICENSE`), unless stated otherwise in-file.

---

## How to update this file
When adding new datasets, services, or bundled tools, include:
1) Dataset/service/tool name  
2) Provider or upstream project  
3) License name/version  
4) Required attribution text  
5) Date accessed/downloaded