Tutorial Model Documentation

From ILMS-Wiki
(Difference between revisions)
Jump to: navigation, search
(Model Documentation)
 
(4 intermediate revisions by one user not shown)
Line 1: Line 1:
 +
[[de:Tutorium_Modelldokumentation]]
 
==Model Documentation==
 
==Model Documentation==
  
Line 5: Line 6:
 
The software automatically generates a complete model documentation.
 
The software automatically generates a complete model documentation.
  
[[Bild:Softwaredokumentation_en.png]]
+
[[File: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:
+
First, JAMS-Doc creates Docbook files for every component which has been used in the model. Those files will be combined to a model documentation in the final step. It contains the following information:  
  
* Metainformationen (Name des Modells, Autor, Erstellungsdatum)
+
* Metadata (name of the model, author, modification date)
* Inhaltsverzeichnis
+
* Table of contents
* Kurze Modellbeschreibung
+
* Short model description
* Aufbau der Modellstruktur
+
* structure of the model
* Komponentendokumentation der in Modell verwendeten Komponenten
+
* component documentation of components used in the model
* Verwendete Modellparameter und deren Werte
+
* model parameters applied and their values
* Literaturverzeichnis
+
* References
  
Folgendermaßen können Sie Ihr Modell dokumentieren:
+
You can document your model as follows:
  
1. Öffnen Sie den JAMS-Builder.
+
1. Open the JAMS-Builder.
  
[[Bild:1.Schritt_ModellDokumentation_en.png]]
+
[[File:1.Schritt_ModellDokumentation_en.png]]
  
2. Laden Sie das Modell, welches dokumentiert werden soll.
+
2. Load the model which is to be documented.
  
[[Bild:2.Schritt_ModellDokumentation_en.png]]
+
[[File:2.Schritt_ModellDokumentation_en.png]]
  
3. Das geladene Modell wurde angezeigt.
+
3. The loaded model has been shown.
  
[[Bild:3.Schritt_ModellDokumentation_en.png]]
+
[[File:3.Schritt_ModellDokumentation_en.png]]
  
4. Wählen Sie in der Menüleiste den Punkt '''Modell''' und den Unterpunkt '''Generiere Modelldokumentation'''.
+
4. Select the item '''Model''' and the sub-item '''Generate Model Documentation'''.
  
[[Bild:4.Schritt_ModellDokumentation_en.png]]
+
[[File: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'''.
+
5. Your model documentation will be generated and saved as *.xml and *.pdf file in the directory '''Documentation''' in the workspace directory (model directory containing all relevant information on the implementation of the model). Additionally, the documentations of all components used and the model paramter directory are in folder '''Documentation''' as *xml.
  
[[Bild:5.Schritt_ModellDokumentation_en.png]]
+
[[File:5.Schritt_ModellDokumentation_en.png]]

Latest revision as of 08:16, 5 December 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, 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.

Softwaredokumentation en.png

First, JAMS-Doc creates Docbook files for every component which has been used in the model. Those files will be combined to a model documentation in the final step. It contains the following information:

  • Metadata (name of the model, author, modification date)
  • Table of contents
  • Short model description
  • structure of the model
  • component documentation of components used in the model
  • model parameters applied and their values
  • References

You can document your model as follows:

1. Open the JAMS-Builder.

1.Schritt ModellDokumentation en.png

2. Load the model which is to be documented.

2.Schritt ModellDokumentation en.png

3. The loaded model has been shown.

3.Schritt ModellDokumentation en.png

4. Select the item Model and the sub-item Generate Model Documentation.

4.Schritt ModellDokumentation en.png

5. Your model documentation will be generated and saved as *.xml and *.pdf file in the directory Documentation in the workspace directory (model directory containing all relevant information on the implementation of the model). Additionally, the documentations of all components used and the model paramter directory are in folder Documentation as *xml.

5.Schritt ModellDokumentation en.png

Personal tools
In other languages