Tutorial Model Documentation
Model Documentation
(Hydrological) Models which have been created using JAMS/J2000 consist of various model components. The documentation software JAMS-Doc which has been integrated into the JAMS-Builder automatically creates a complete model documentation. As input variables it uses the model's description in *.xml format which is automatically loaded within the JAMS_Builder. It contains information on the model's structure, the model components which have been used and the model parametrization; this information is to be extracted. In addition, the JAMS and model libraries have to be available in order to read the information about components from the source code. The software automatically generates a complete model documentation.
Bild:Softwaredokumentation_en.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.
