DOKUMENTATIONSERSTELLUNG FÜR DAS JENA ADAPTABLE MODELING SYSTEM (JAMS)

Transkript

1 DOKUMENTATIONSERSTELLUNG FÜR DAS JENA ADAPTABLE MODELING SYSTEM (JAMS) CHRISTIN MICHEL LEHRSTUHL FÜR GEOINFORMATIK, GEOHYDROLOGIE UND MODELLIERUNG, FSU JENA 3. TASK Symposium, Leipzig, 8. Juni 2011

2 Motivation Entwicklung der Simulationsplattform Jena Adaptable Modelling System (JAMS) am Lehrstuhl für Geoinformatik der Friedrich-Schiller-Universität Jena Entwicklung darauf basierender Modelle zur Modellierung, Analyse und Bewertung von Umweltmodellen Für die Markteinführung: ausführliche Dokumentation unumgänglich!

3 s1 Inhalte des Projekts Erstellung einer Software zur automatischen Modelldokumentation Erstellung eines Modulkataloges Online-Tutorien Folgende Komponenten sollen dokumentiert werden: Komponenten der Modellierungsumgebung JAMS Komponenten des hydrologischen Modells J2000 Anfänger Fortgeschrittene Benutzer Modellentwickler

4 Folie 3 s1 Modelldukumentation sa63kol;

5 Aufbau der Simulationsplattform/ Modellkonzept JAMS/J2000 sind in JAVA implementiert Modular aufgebaut Komponenten und Kontextkomponenten

6 Komponentendokumentation Beschreibung der wissenschaftlichen Grundlagen/ Inhalte der Komponenten Verwendete Algorithmen, Literatur, eventuell Anwendungsbeispiele Technische Beschreibung der Komponenten Metainformationen Name, Autor, Version, Erstellungsdatum Beschreibung der Ein- und Ausgabedaten Name, Beschreibung, gültiger Wertebereich, Defaultwert, Einheit

7 Komponentendokumentation Ein Beispiel Name der Komponente Kurze Beschreibung Metainformationen Eingangsvariablen Ausgabevariablen Beschreibung der Komponente

8 Dokumentationssoftware Erstellt automatisch eine komplette Modelldokumentation Modelldokumentation Modellbeschreibung Dokumentationssoftware JAMS Bibliotheken J2000 Bibliotheken Mehrsprachigkeit soll unterstützt werden Vorerst: deutsch und englisch Flexibles Konzept, sodass die Dokumentation auf beliebige Sprachen erweiterbar ist

9 Aufbau einer Dokumentation Modelldokumentation Inhaltsverzeichnis Kurze Modellbeschreibung Aufbau der Modellstruktur Komponentendokumentation der im Modell verwendeten Komponenten Verwendete Modellparameter Literaturverzeichnis

10

11 Online-Tutorien Erläuterung unseres Softwarepakete in WikiDoc JUICE zum Aufsetzten eines Modells JAMS Launcher zur Modellierung JADE zur Ergebnisauswertung Werkzeukkasten zum Ableiten von Modelleinheiten Übungsaufgaben, um die Strukturen besser zu verinnerlichen

12 Zusammenfassung Umfassendes Dokumentationskonzept wurde erstellt Softwaredokumentation: Dokumentationsrichtlinien für den Quellcode Vorlagen für manuelle Komponentendokumentation Erstellung einer automatischen Modelldokumentation Online-Tutorien Erläutern der Funktionsweise und Bedienung der Software Verschiedene Nutzergruppen werden angesprochen Übungsaufgaben zum besseren Verständnis

13

14 Dokumentationssoftware - Bestandteile Dokumentationssoftware

15 Dokumentationssoftware - Bestandteile Modell Auswertung - XML Parser Analysiert die Modellstruktur Findet Modellparameter und dessen Werte Quellcode Parser Extrahiert die Bemerkungen aus dem Quellcode Komponentenbemerkungen (Titel, Autor, Datum, Version) Variablenbemerkungen (Zugriffsart, Beschreibung, Einheit, obere Grenze, untere Grenze, Defaultwert) Entwicklerdokumentation Ergänzende Bemerkungen zu den Komponente und deren Variablen Inhaltliche Beschreibung der Komponente (verwendete Algorithmen, ) Angaben zur Literatur

16 Arbeitsweise der Dokumentationssoftware Modell Dokumentationstool Analyse der Modellstruktur Modellstruktur für Dokumentation Modellparameter Kontextkomponente Komponente Komponentendokumentationstool Parameter Komponentenparameter (aus der Modellbeschreibung) Entwicklerdokumentation (manuell) Quellcodedokumentation (automatisch) J2000 Bibliotheken Kurze Modellbeschreibung Komponentendokumentation JAMS Bibliotheken

17 Mehrsprachigkeit Dokumentation soll in der englischen und in der deutsche Sprache erstellt werden Ziel: Konzept für weiter Sprachanbindungen offen gestalten Idee: Quellcodedokumentation Entwicklerdokumentation (deutsch) Komponentendokumentation (deutsch) Entwicklerdokumentation (englisch) Komponentendokumentation (englisch) Entwicklerdokumentation (portugisisch) Komponentendokumentation (portugisisch) sprachunabhängig sprachabhängig Mehrsprachige Dokumentation

18 Software Welche Software soll zur Realisierung des Projektes verwendet werden? Analyse der Leistungsfähigkeit folgender Pakete: Java DocBook Latex Modell- und Komponentendokumentation Darwin Information Typing Architecture (DITA) WikiDoc Tutorien