ALGAE pre - README (noch ein paar Infos)
----------------------------------------------------

1. Die Programmbenutzung
------------------------
Das Programm kann entweder im BatchModus oder im GUI-Modus gestartet werden.

  a) Der BatchModus
  -----------------
  Im den Batchmodus ins Leben zu rufen, muá man die Datei "Main.class"
  mit einem Parameter (zu benutzendes Settingsfile) aufrufen.

  Also z.B. (auf WIN9X System)
      java -classpath ".;algae\simulation\xml.jar" Main demo3.asf

  auf einem UNIX/Linux System duerfte das in etwa so aussehen:
      java -classpath ".:algae/simulation/xml.jar" Main demo3.asf

  Dann wird das Settingsfile eingelesen, und die Simulation startet.
  Als Dateinamen fuer die Statistik-Datei wird einfach ein .stat an
  den Settings-File-Namen angehaengt (also im vorigen Beispiel
  wird eine Statistik-Datei namens "demo3.asf.stat" erzeugt).

  Bei jedem Simulationsschritt werden noch diverse Informationen ausgegeben
  (in etwa, ob eine Alge geboren wurde, ob eine Alge gestorben ist, usw.).
  Manche dieser Informationen sind noch Debug-Infos und werden dann in der
  endgueltigen Version nicht mehr vorhanden sein.

  b) Der GUI-Modus
  ----------------
  Ruft man die Main.class ohne Parameter auf,

  also z.B. (auf WIN9X System)
      java -classpath ".;algae\simulation\xml.jar" Main 

  auf einem UNIX/Linux System duerfte das in etwa so aussehen:
      java -classpath ".:algae/simulation/xml.jar" Main 

  dann erscheint der SettingsDialog. Hier kann man nun entweder ueber "Load"
  ein SettingsFile laden, oder (wenn sich das gewuenschte SettingsFile im
  Verzeichnis von Main.class befindet) es einfach ueber die DropDown-Liste
  rechts unten laden.

  Wenn man will, kann man noch Parameter editieren. Wenn man dann mit den
  Einstellungen zufrieden ist, wird das ganze ueber "OK" bestaetigt und
  nach kurzer Initialisierungs-Zeit erscheint das Simulations-Fenster.

  Mit Hilfe der Buttonleiste am oberen Rand, kann man den Ablauf des
  Programmes steueren, in der Mitte is das Aquarium und unten wird
  in einer Statuszeile immer der aktuelle Zustand des Programmes
  ausgegeben.

  Im "Optionen"-Feld kann man noch verschiedene Darstellungs-Einstellungen
  vornehmen. Ausserdem findet man hier die DropDown-Liste, welche fuer die
  Agentenauswahl zustaendig ist (diese ist nur aktiv, wenn die Simulation
  angehalten ist, da es sonst zu unschoenen Darstellungsfehlern kommt).

  Ist ein Agent ausgewaehlt, so kann man ein Infofenster ueber das Menue
  oeffnen, welche die Daten des ausgewaehlten Agenten anzeigt.

  Will man eine neue Simulation starten, dann einfach das Simulations-fenster
  schliessen und man landet wieder im Settingsdialog, von wo aus man wieder
  eine neue Simulation starten kann.

2) Das Dateiformat der Statistik-Dateien
----------------------------------------
Die Statistikdateien sind reine Text-Files, welche in bestimmte Sektionen
unterteilt sind.

* [SECTION SETTINGS]
  Dieser Abschnitt steht am Anfang der Datei und beinhaltet alle
  Informationen rund um den Ausgangszustand.

  <SUBSECTION SIMULATION>
  Dieser Unterabschnitt enthaelt nun die Informationen, welche
  fuer den Ausgangszustand einer Simulation zustaendig sind
  (siehe SettingsDialog)

  <SUBSECTION AGENT n>
  Diese Untersektion enthaelt den Agenten n, welcher am Anfang initialisiert
  wurde, mit allen wichtigen Werten gespeichert (Index, Phenotyp,...).

  Es gibt genausoviele Untersektionen dieses Typs, wie es Agenten gibt.

* [SECTION STEP n]
  Diese Sektion enthaelt alle Informationen darueber, was im Simulations-
  schritt n passiert ist.

  <SUBSECTION GENERAL STATS>
  Diese Sektion enthaelt Informationen darueber, wieviel Substrat verbraucht
  wurde, wieviele Agenten gestorben sind, wieviele Agenten am leben sind,
  usw.

  <SUBSECTION AGENT x>
  Fuer jeden Agenten, der noch am Leben ist, gibt es eine solche
  Untersektion.
  Diese enthaelt Informationen darueber, was der Agent in diesem
  Simulationsschritt so gemacht hat (mitose, meiose, substrate gesammelt,...).
  Ausserdem der komplette Phenotyp eines Agenten mit allen Matrizen in einem
  solchen Unterabschnitt vorhanden). Das ist auch der Grund, warum die Datei
  so gross wird und solange braucht, fuers schreiben (deshalb ist die
  Statistik-Speicherung nur im BatchModus vorhanden).


So, ich glaube im grossen und ganzen gibt diese Datei zumindest einen groben
Ueberblick ueber das Programm.

Im uebrigen liegen dem Programm noch ein paar *.ASF Files bei (SettingsFile),
mit welchen ich so herumexperimentiert habe.

Also, dann wuensche ich viel Spass beim herumexperimentieren und ich hoffe
es treten keine Fehler auf.