Tutorial Model Documentation
Modelldokumentation
(Hydrologische) Modelle, die mit JAMS/J2000 erstellt worden sind, bestehen aus einer Vielzahl von Modellkomponenten. Die Dokumentationssoftware JAMS-Doc, welche in den JAMS-Builder integriert worden ist, erstellt automatische eine komplette Modelldokumentation. Als Eingabegrößen erwartet sie zum einen die Modellbeschreibung welche im *.xml Format vorliegt. Diese wird automatisch innerhalb des JAMS_Builders geladen. In dieser sind Informationen zur Modellstruktur, zu den verwendeten Modellkomponenten sowie zur Modellparametrisierung verankert, welche zu extrahieren sind. Weiterhin müssen die JAMS- sowie die Modell-Bibliotheken zur Verfügung gestellt werden, damit die im Quellcode verankerten Informationen zu den Komponenten herausgeschrieben werden können. Die Software erstellt dann automatische eine komplette Modelldokumentation.
Bild:Softwaredokumentation.png
Zu Beginn werden von JAMS-Doc zu jeder im Modell verwendeten Komponente Docbook-Dateien erstellt, die im finalen Schritt zu einer Modelldokumentation zusammengesetzt werden. Diese beinhaltet die folgenden Bestandteile:
- Metainformationen (Name des Modells, Autor, Erstellungsdatum)
- Inhaltsverzeichnis
- Kurze Modellbeschreibung
- Aufbau der Modellstruktur
- Komponentendokumentation der in Modell verwendeten Komponenten
- Verwendete Modellparameter und deren Werte
- Literaturverzeichnis
Folgendermaßen können Sie Ihr Modell dokumentieren:
1. Öffnen Sie den JAMS-Builder.
Bild:1.Schritt_ModellDokumentation_en.png
2. Laden Sie das Modell, welches dokumentiert werden soll.
Bild:2.Schritt_ModellDokumentation_en.png
3. Das geladene Modell wurde angezeigt.
Bild:3.Schritt_ModellDokumentation_en.png
4. Wählen Sie in der Menüleiste den Punkt Modell und den Unterpunkt Generiere Modelldokumentation.
Bild:4.Schritt_ModellDokumentation_en.png
5. Ihre Modelldokumentation wird erstellt und als *.xml sowie als *.pdf Datei im Verzeichnis Dokumentation im Workspace-Verzeichnis (Modellverzeichnis, indem alle relevanten Informationen für die Ausführung des Modells hinterlegt sind) gespeichert. Weiterhin liegen die Dokumentationen aller verwendeten Komponenten sowie das Modell-Parameterverzeichnis als *.xml im Ordner Dokumentation.
