Tutorial Model Documentation
(→Modelldokumentation) |
(→Modelldokumentation) |
||
| Line 1: | Line 1: | ||
| − | == | + | ==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 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. | 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. | Die Software erstellt dann automatische eine komplette Modelldokumentation. | ||
Revision as of 13:17, 24 June 2011
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 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_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.
