machine-readable_anwendungshandbuecher

Dieses Repository enthält Anwendungshandbücher (AHB) in einem maschinenlesbaren Format, das deutlich einfacher zu verarbeiten ist als .docx oder .pdf. Wir pflegen analog zu den hier abgelegten Daten auch:

edi_energy_ahb_conditions_and_packages für Bedingungen und Paket-Definitionen aus den AHBs
machine-readable_message-implementation-guide für MIGs
machine-readable_entscheidungsbaumdiagramme für EBDs

Unter der Haube

Zur Erstellung der hier veröffentlichten Daten nutzen wir kohlrahbi, eine Open Source AHB Scraping Library. Änderungen auf edi-energy.de werden mehrmals täglich automatisiert über unseren edi_energy_mirror in dieses Repository synchronisiert.

Struktur & Datenformate

Zur Strukturierung nutzen wir nicht die Format- oder AHB-Versionen (z.B. UTILMD 5.2e oder GPKE AHB 6.1e), sondern lediglich den Zeitraum zu dem die Daten gültig sind. Beispielsweise bezeichnet FV2210 die Datenformate, die seit 2022-10-01 gültig sind oder FV2304 die Datenformate, die seit 2023-04-01 gültig sind.

Die Anwendungshandbücher sind als je eine Datei pro Prüfidentifikator in jeweils drei Serialisierungs-Formaten verfügbar:

CSV
Excel
JSON (mit FlatAnwendungshandbuch aus dem MIG AHB Utility Stack (maus 🐭) als zugrunde liegendes Datenmodell)

Es macht wenig Sinn binäre Dateiformate wie bpsw. xlsx Dateien in git zu versionieren. Daher verwenden wir in diesem Repoository Git LFS (Large File Storage) um die Excel-Dateien zu versionieren. Was Git LFS ist und wie es funktioniert, ist hier beschrieben. Gitkraken hat auch eine eigene Anleitung für Git LFS.

Motivation

Wir freuen uns über jede durch dieses Repository ersparte Stunde Arbeit, in der wichtige Probleme gelöst werden können anstatt AHBs zu scrapen.

Urheberrecht

Das Urheberrecht der hier versionierten Daten liegt bei EDI@energy bzw. den Autor*innen der Anwendungshandbücher selbst. Dieses Repository macht die Daten aus den AHBs lediglich leichter zugänglich. Hochfrequenz garantiert weder für die Korrektheit noch die Vollständigkeit der hier bereitgestellten Daten.

Rückmeldungen & Mitwirken

Es ist sehr wahrscheinlich, dass die hier bereitgestellten Daten nicht fehlerfrei sind. Probleme oder Fehler können gerne als Issue gemeldet werden. Weil die Daten in diesem Repository aber maschinell erstellt und ggf. überschrieben werden, sind manuelle Anpassungen bzw Pull Requests nicht langfristig hilfreich. Besser ist es, das Scraping in kohlrahbi zu fixen.

Weiterführendes Tooling

Dieses Repository ist Teil der Hochfrequenz Libraries und Tool für eine echte Digitalisierung der Marktkommunikation.

hochfrequenz / machine-readable_anwendungshandbuecher Goto Github PK