Tutorium Modelldokumentation - Versionsgeschichte

Chr am 28. November 2011 um 15:16 Uhr

2011-11-28T15:16:12Z

← Nächstältere Version		Version vom 28. November 2011, 15:16 Uhr
Zeile 1:		Zeile 1:
		+	[[en:Tutorial_Model_Documentation]]
	==Modelldokumentation==		==Modelldokumentation==

Christin am 23. Juni 2011 um 08:47 Uhr

2011-06-23T08:47:18Z

← Nächstältere Version		Version vom 23. Juni 2011, 08:47 Uhr
Zeile 38:		Zeile 38:

	[[Bild:5.Schritt_ModellDokumentation.png]]		[[Bild:5.Schritt_ModellDokumentation.png]]
−
−	So ist im Allgemeinen das Arbeitsverzeichnis eines JAMS-Projektes gegliedert. Im Ordner '''documentation''' liegen nun die fertigen Dokumentationsdokumente Dokumentation_komplett.pdf und Dokumentation_komplett.xml.
−
−	~~[[Bild:Workspace_Dokumentation.png]]~~

	So ist im Allgemeinen das Arbeitsverzeichnis eines JAMS-Projektes gegliedert. Im Ordner '''documentation''' liegen nun die fertigen Dokumentationsdokumente Dokumentation_komplett.pdf und Dokumentation_komplett.xml.		So ist im Allgemeinen das Arbeitsverzeichnis eines JAMS-Projektes gegliedert. Im Ordner '''documentation''' liegen nun die fertigen Dokumentationsdokumente Dokumentation_komplett.pdf und Dokumentation_komplett.xml.

	[[Bild:Workspace_Dokumentation.png]]		[[Bild:Workspace_Dokumentation.png]]

Christin: /* Modelldokumentation */

2011-06-22T13:57:44Z

Modelldokumentation

← Nächstältere Version		Version vom 22. Juni 2011, 13:57 Uhr
Zeile 38:		Zeile 38:

	[[Bild:5.Schritt_ModellDokumentation.png]]		[[Bild:5.Schritt_ModellDokumentation.png]]
		+
		+	So ist im Allgemeinen das Arbeitsverzeichnis eines JAMS-Projektes gegliedert. Im Ordner '''documentation''' liegen nun die fertigen Dokumentationsdokumente Dokumentation_komplett.pdf und Dokumentation_komplett.xml.
		+
		+	[[Bild:Workspace_Dokumentation.png]]

	So ist im Allgemeinen das Arbeitsverzeichnis eines JAMS-Projektes gegliedert. Im Ordner '''documentation''' liegen nun die fertigen Dokumentationsdokumente Dokumentation_komplett.pdf und Dokumentation_komplett.xml.		So ist im Allgemeinen das Arbeitsverzeichnis eines JAMS-Projektes gegliedert. Im Ordner '''documentation''' liegen nun die fertigen Dokumentationsdokumente Dokumentation_komplett.pdf und Dokumentation_komplett.xml.

	[[Bild:Workspace_Dokumentation.png]]		[[Bild:Workspace_Dokumentation.png]]

Christin: /* Modelldokumentation */

2011-06-22T13:56:40Z

Modelldokumentation

← Nächstältere Version		Version vom 22. Juni 2011, 13:56 Uhr
Zeile 35:		Zeile 35:
	[[Bild:4.Schritt_ModellDokumentation.png]]		[[Bild:4.Schritt_ModellDokumentation.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. Ihre Modelldokumentation wird erstellt und als .xml sowie als .pdf Datei im Verzeichnis '''Dokumentation''' im Arbeitsverzeichnis (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.png]]		[[Bild:5.Schritt_ModellDokumentation.png]]
		+
		+	So ist im Allgemeinen das Arbeitsverzeichnis eines JAMS-Projektes gegliedert. Im Ordner '''documentation''' liegen nun die fertigen Dokumentationsdokumente Dokumentation_komplett.pdf und Dokumentation_komplett.xml.
		+
		+	[[Bild:Workspace_Dokumentation.png]]

Christin: /* Modelldokumentation */

2011-06-22T09:58:49Z

Modelldokumentation

← Nächstältere Version		Version vom 22. Juni 2011, 09:58 Uhr
Zeile 1:		Zeile 1:
	==Modelldokumentation==		==Modelldokumentation==

−	(Hydrologische) Modelle, die mit JAMS/J2000 erstellt worden sind, bestehen aus einer Vielzahl von Modellkomponenten. ~~Die dokumentationssoftware JAMS-Doc erstellt automatisch eine komplette 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.
−	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 ~~JUICE~~ 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.		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-22T09:52:35Z

Modelldokumentation

← Nächstältere Version		Version vom 22. Juni 2011, 09:52 Uhr
Zeile 36:		Zeile 36:
	[[Bild:4.Schritt_ModellDokumentation.png]]		[[Bild:4.Schritt_ModellDokumentation.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.	+	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.png]]		[[Bild:5.Schritt_ModellDokumentation.png]]

Christin: /* Modelldokumentation */

2011-06-22T09:49:52Z

Modelldokumentation

← Nächstältere Version		Version vom 22. Juni 2011, 09:49 Uhr
Zeile 6:		Zeile 6:
	Die Software erstellt dann automatische eine komplette Modelldokumentation.		Die Software erstellt dann automatische eine komplette Modelldokumentation.

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

2011-06-22T09:39:24Z

Modelldokumentation

← Nächstältere Version		Version vom 22. Juni 2011, 09:39 Uhr
Zeile 21:		Zeile 21:

	1. Öffnen Sie den JAMS-Builder.		1. Öffnen Sie den JAMS-Builder.
		+
		+	[[Bild:1.Schritt_ModellDokumentation.png]]

	2. Laden Sie das Modell, welches dokumentiert werden soll.		2. Laden Sie das Modell, welches dokumentiert werden soll.
		+
		+	[[Bild:2.Schritt_ModellDokumentation.png]]

	3. Das geladene Modell wurde angezeigt.		3. Das geladene Modell wurde angezeigt.
		+
		+	[[Bild:3.Schritt_ModellDokumentation.png]]

	4. Wählen Sie in der Menüleiste den Punkt '''Modell''' und den Unterpunkt '''Generiere Modelldokumentation'''.		4. Wählen Sie in der Menüleiste den Punkt '''Modell''' und den Unterpunkt '''Generiere Modelldokumentation'''.
		+
		+	[[Bild:4.Schritt_ModellDokumentation.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.		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.
		+
		+	[[Bild:5.Schritt_ModellDokumentation.png]]

Christin am 22. Juni 2011 um 09:34 Uhr

2011-06-22T09:34:41Z

Neue Seite

==Modelldokumentation==

(Hydrologische) Modelle, die mit JAMS/J2000 erstellt worden sind, bestehen aus einer Vielzahl von Modellkomponenten. Die dokumentationssoftware JAMS-Doc erstellt automatisch eine komplette Modelldokumentation.
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 JUICE 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.

2. Laden Sie das Modell, welches dokumentiert werden soll.

3. Das geladene Modell wurde angezeigt.

4. Wählen Sie in der Menüleiste den Punkt '''Modell''' und den Unterpunkt '''Generiere Modelldokumentation'''.

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.