Anleitung

Um die Hausaufgabe zu erledigen müßt Ihr mit die folgenden Schritte abarbeiten, Erläuterung kommt danach:

  1. Dokumentiert Euer Modell und Eure Parameter in models/name.py
  2. Erzeugt die Dokumentations - Dateien
  3. Beschreibt Euer Konzept
  4. Beschreibt Eure Ergebnisse und schreibt eine Diskussion

1. models/name.py

Schreibt den doc-string vom Modul so, dass er sowohl das Modul ganz gut beschreibt, als auch als Einstieg in die Dokumentation funktioniert. Meine ursprüngliche Idee die Überschrift „Einleitung“ zu verwenden, war nicht so gut. Bitte Ändern.

In Eurem Modell sollt Ihr in der Parameters Klasse alle „doc“ Attribute auf Deutsch so schreiben, das es richtig ist. Die Sprache ist wichtig, damit es auf jedenfall nicht von mir ist.

Bewertung:Die Beschreibung der Parameter macht 15% der Note aus.

Außerdem sollt Ihr jede Methode in Eurer Klasse erläutern. Auch hier verwendet ihr reStructuredText (s. reStructuredText-Primer), evtl. sogar mit einer Erläuterung der Parameter und der Rückgabe Python-Doc. Wichtiger ist aber, dass die Intention des Codes über doc-strings Erläutert wird. Habt ihr das Gefühl das eine Methode zu viel für einen docstring macht?

Mach einfach zwei Methoden draus!

Bewertung:Die Beschreibung der Methoden macht 25% der Note aus

2. Dokumentations-Dateien erzeugen

Führt das Programm makedoc_name.py aus. Das erzeugt aus Eurem Modell folgende Dateien:

  • output/name/name.main.rst enthält das Inhaltsverzeichnis und den docstring von Eurem Modul, da gibt es eigentlich nix dran zu ändern.
  • output/name/name.implementation.rst enthält alle Implementierungs-Details und sollte nicht geändert werden. Wenn was nicht passt zurück zu 1.
    • Die Parameter mit ihren doc-Attributen
    • Die Modell-Klasse mit allen Methoden
    • Das CMF-Modell
  • output/name/name.concept.rst - hier beschreibt Ihr Euer Konzept. Die Vorlage zeigt, wie Ihr auf die Ergebnis-abbildungen verweisen könnt.

Diesen Schritt könnt ihr immer wieder wiederholen um zu sehen wie das Ergebnis aussieht. Wenn output/name/name.concept.rst schon existiert, wird es nicht überschrieben!

3. output/name/name.concept.rst

Beschreibt hier Euer Konzept mit reStructured Text, das ist im reStructuredText-Primer beschrieben. Wenn Ihr Anregungen für Euer Konzept in der Literatur hattet, verwendet Zitate.

Wenn ihr wissen wollt, ob Euer Text auch schön gerendert wird könnt ihr ein Online-Tool verwenden, oder ihr wiederholt Schritt 2.

Bewertung:Dieser Teil wird 15% der Note auf die Hausaufgabe ausmachen, weil das Konzept schließlich auch schon im mündlichen Teil bewertet wurde. Mehr als 400 Wörter braucht man da nicht zu verlieren

4. output/name/name.result.rst

Hier kommen die Ergebnisse und die Diskussion rein. An den Ergebnissen braucht ihr nicht viel machen, außer auf die Effekte hinweisen, die ihr in der Diskussion aufgreift - deshalb zählt das auch nur 15% der Note.

Für die Diskussion könnt ihr die Ergebnisse Eurer Kollegen nutzen um Euer Konzept im vergleich zu den anderen Ergebnissen zu diskutieren. Simulationsergebnisse von lumped-Modellen aus der Literatur können natürlich auch zitiert werden.

Die derzeitigen Ergebnisse findet ihr unter: http://fb09-pasig.umwelt.uni-giessen.de/mp111.2018

Bewertung:Obwohl die Diskussion 30% der Note ausmacht, reichen 500 - 800 Wörter bestimmt aus.

5. Abgabe

Bitte schickt mir Euer dokumentiertes Modell sowie die Dateien name.concept.rst und name.result.rst. Falls Ihr Euer Konzept noch überarbeiten wollt, brauche ich natürlich auch die name.concept.png Datei. Ihr könnt auch gerne „mehrfach“ einreichen, um Eure Kollegen besser bei der Diskussion zu unterstützen. Ich bewerte erst nach dem Abgabetermin.