Tutorial Model Documentation - Revision history

Chr at 08:16, 5 December 2011

2011-12-05T08:16:58Z

← Older revision		Revision as of 08:16, 5 December 2011
Line 6:		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]]

	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:		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:
Line 22:		Line 22:
	1. Open the JAMS-Builder.		1. Open the JAMS-Builder.

−	[[~~Bild~~:1.Schritt_ModellDokumentation_en.png]]	+	[[File:1.Schritt_ModellDokumentation_en.png]]

	2. Load the model which is to be documented.		2. Load the model which is to be documented.

−	[[~~Bild~~:2.Schritt_ModellDokumentation_en.png]]	+	[[File:2.Schritt_ModellDokumentation_en.png]]

	3. The loaded model has been shown.		3. The loaded model has been shown.

−	[[~~Bild~~:3.Schritt_ModellDokumentation_en.png]]	+	[[File:3.Schritt_ModellDokumentation_en.png]]

	4. Select the item '''Model''' and the sub-item '''Generate Model Documentation'''.		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. 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. 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]]

Chr at 16:34, 28 November 2011

2011-11-28T16:34:43Z

← Older revision		Revision as of 16:34, 28 November 2011
Line 1:		Line 1:
		+	[[de:Tutorium_Modelldokumentation]]
	==Model Documentation==		==Model Documentation==

Chr: hat „Tutorium Modelldokumentation en“ nach „Tutorial Model Documentation“ verschoben

2011-11-28T14:03:55Z

hat „Tutorium Modelldokumentation en“ nach „Tutorial Model Documentation“ verschoben

← Older revision

Revision as of 14:03, 28 November 2011

Chr: /* Model Documentation */

2011-06-24T13:37:47Z

Model Documentation

← Older revision		Revision as of 13:37, 24 June 2011
Line 31:		Line 31:
	[[Bild:3.Schritt_ModellDokumentation_en.png]]		[[Bild:3.Schritt_ModellDokumentation_en.png]]

−	4. Select the item '''Model''' and the sub-item '''~~Generated~~ Model Documentation'''.	+	4. Select the item '''Model''' and the sub-item '''Generate Model Documentation'''.

	[[Bild:4.Schritt_ModellDokumentation_en.png]]		[[Bild:4.Schritt_ModellDokumentation_en.png]]

Chr: /* Model Documentation */

2011-06-24T13:36:41Z

Model Documentation

← Older revision		Revision as of 13:36, 24 June 2011
Line 7:		Line 7:
	[[Bild:Softwaredokumentation_en.png]]		[[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~~:	+	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]]		[[Bild: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]]		[[Bild:2.Schritt_ModellDokumentation_en.png]]

−	3. ~~Das geladene Modell wurde angezeigt~~.	+	3. The loaded model has been shown.

	[[Bild:3.Schritt_ModellDokumentation_en.png]]		[[Bild: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 '''Generated Model Documentation'''.

	[[Bild:4.Schritt_ModellDokumentation_en.png]]		[[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~~'''.	+	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]]		[[Bild:5.Schritt_ModellDokumentation_en.png]]

Chr: /* Model Documentation */

2011-06-24T13:21:55Z

Model Documentation

← Older revision		Revision as of 13:21, 24 June 2011
Line 1:		Line 1:
	==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 ~~In dieser sind Informationen zur Modellstruktur~~, ~~zu den verwendeten Modellkomponenten sowie zur Modellparametrisierung verankert, welche zu extrahieren sind~~.	+	(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.
−	~~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~~.	+	In addition, the JAMS and model libraries have to be available in order to read the information about components from the source code.
−	~~Die Software erstellt dann automatische eine komplette Modelldokumentation~~.	+	The software automatically generates a complete model documentation.

	[[Bild:Softwaredokumentation_en.png]]		[[Bild:Softwaredokumentation_en.png]]

Chr: /* Modelldokumentation */

2011-06-24T13:17:18Z

Modelldokumentation

← Older revision		Revision as of 13:17, 24 June 2011
Line 1:		Line 1:
−	==~~Modelldokumentation~~==	+	==Model Documentation==

−	(~~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.	+	(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.

Christin: /* Modelldokumentation */

2011-06-22T13:43:30Z

Modelldokumentation

← Older revision		Revision as of 13:43, 22 June 2011
Line 5:		Line 5:
	Die Software erstellt dann automatische eine komplette Modelldokumentation.		Die Software erstellt dann automatische eine komplette Modelldokumentation.

−	[[Bild:~~Softwaredokumentation~~.png]]	+	[[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:		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:

Christin at 13:42, 22 June 2011

2011-06-22T13:42:44Z

New page

==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'''.

[[Bild:5.Schritt_ModellDokumentation_en.png]]