Skip to content

Commit

Permalink
docs: add documentation related to Coverage Areas
Browse files Browse the repository at this point in the history
SVC-1812
  • Loading branch information
florianesser committed Sep 10, 2024
1 parent e2dc5da commit 4c4b9aa
Showing 1 changed file with 32 additions and 0 deletions.
32 changes: 32 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -149,6 +149,20 @@ Für den Datenfluss 7_10 wird in der Standardkonfiguration folgende Ordnerstrukt
| │ ├─ <Plan_n>/
│ ├─ output/
│ ├─ validation/
├─ coverage_areas/
│ ├─ UBA-DE_Gebiet_to_DF7_10_CoverageArea.halez
│ ├─ DF7_10_CoverageArea_Aggregations.halez
│ ├─ input/
| │ ├─ <Plan_1>/
| | | ├─ <Plandatei_UBA>.xlsx
| | | ├─ LAP_Gebiet.shp (+ zugehörige Dateien)
| │ ├─ <Plan_2>/
| │ ├─ ...
| │ ├─ <Plan_n>/
│ ├─ VG250/
| │ ├─ VG250_GEM.shp (+ zugehörige Dateien)
| │ ├─ VG250_RBZ.shp (+ zugehörige Dateien)
| │ ├─ VG250_VWG.shp (+ zugehörige Dateien)

### Validierung

Expand All @@ -165,11 +179,20 @@ Die detaillierten Log-Ausgaben und Berichte werden im jeweiligen Ausgabeverzeich
(z. B. `<configBasePath>/majorroad/validation/Plan_1`) abgelegt. Folgende Dateien werden erzeugt:

- `DF7_10_NAP_<Quelle>_<Plan>.xlsx` - Ins EEA-Format überführter Plan
- `LAP_Gebiet_<Plan>.gpkg` - Abgeleiteter Gültigkeitsbereich
- `out.log` - Standardausgabe (stdout)
- `err.log` - Standardfehlerausgabe (stderr)
- `reports.out` - hale-Berichtsdatei
- `statistics.json` - Statistikdatei im JSON-Format

Im Unterverzeichnis `logs_coverage_area` werden außerden die Log-Ausgaben und Berichte für die Ableitung der
Gültigkeitsbereiche abgelegt:

- `out.log` - Standardausgabe (stdout)
- `err.log` - Standardfehlerausgabe (stderr)
- `reports_coveragearea.out` - hale-Berichtsdatei zur Ableitung des Gültigkeitsbereichs
- `statistics_coveragearea.json` - Statistikdatei im JSON-Format zur Ableitung des Gültigkeitsbereichs

## Aggregation

Alle ins EEA-Format überführten Excel-Vorlagen können dann in einem zweiten Schritt aggregiert werden. Mit dem Befehl
Expand All @@ -187,11 +210,20 @@ Die detaillierten Log-Ausgaben und Berichte werden im Ausgabeverzeichnis der Que
(z. B. `<configBasePath>/majorroad/output`) abgelegt. Folgende Dateien werden erzeugt:

- `<Vorlagenname>_aggregated.xlsx` - Aggregierte Daten
- `LAP_Gebiet_nap-<Quelle>_aggregated.gpkg` - Aggregierte Gültigkeitsbereiche
- `out.log` - Standardausgabe (stdout)
- `err.log` - Standardfehlerausgabe (stderr)
- `reports.out` - hale-Berichtsdatei
- `statistics.json` - Statistikdatei im JSON-Format

Im Unterverzeichnis `logs_coverage_area` werden außerden die Log-Ausgaben und Berichte für die Ableitung der
Gültigkeitsbereiche abgelegt:

- `out.log` - Standardausgabe (stdout)
- `err.log` - Standardfehlerausgabe (stderr)
- `reports_coveragearea.out` - hale-Berichtsdatei zur Ableitung des Gültigkeitsbereichs
- `statistics_coveragearea.json` - Statistikdatei im JSON-Format zur Ableitung des Gültigkeitsbereichs

## Bekannte Probleme

Bei der Ausführung der Gradle-Aufgaben kann es vermehrt zu den u. a. oder ähnlichen Konsolenausgaben kommen. Die Meldungen
Expand Down

0 comments on commit 4c4b9aa

Please # to comment.