BlueM.Sim application: Difference between revisions

From BlueM
Jump to navigation Jump to search
(→‎Simulation: Screenshot)
m (fix download links)
 
(25 intermediate revisions by 4 users not shown)
Line 1: Line 1:
__NOTOC__
__NOTOC__
{{BlueM_nav}}
This page is an aid to the application of BlueM.


Diese Seite ist eine Hilfe zur Anwendung von BlueM.
==Dataset==
* A BlueM.Sim dataset consists of several text files. The minimum requirements are an [[ALL-File]] - (general options) and a [[SYS-File]] - (System Plan). Furthermore, files for describing the different types of system elements must be included. All files must have the same filename (which is also the name of the dataset), only the file extensions differ. <small>(The name of the dataset should not be longer than 32 characters! ''See Bug 13'')</small>
* A QGIS plugin for creating BlueM.Sim input files, developed by Martin Grosshaus as part of his Master Thesis, is available on GitHub: https://github.com/bluemodel/BlueM.QGISInterface
* It is possible to create a dataset using [[TALSIM]], which can then be exported and used for BlueM.Sim. Minor modifications to the export files need to be carried out (see [[TALSIM Export]]).
''See also [[BlueM Eingabedateien|Input files]]''


==Datensatz==
==Simulation==
* Ein Datensatz besteht aus einer [[TSIM.ALL|ALL]]- (Allgemeine Angaben) und einer [[TSIM.SYS|SYS]]-Datei (Systemplan), sowie den Dateien, die für die verschiedenen im Systemplan angegebenen Systemelemente zuständig sind. Alle Dateien müssen den gleichen Dateinamen (= Datensatzname) haben, nur die Dateiendungen unterscheiden sich. <small>(Der Name des Datensatzes darf aus nicht mehr als 32 Zeichen bestehen! ''siehe Bug 13'')</small>
[[File:BlueMWin_screenshot.png|thumb|BlueM.Win Screenshot]]
* Es ist möglich, einen Datensatz mithilfe von [[TALSIM]] zu erstellen, dieser kann dann exportiert werden und für BlueM verwendet werden. Dazu sind kleinere Modifikationen an den Exportdateien erforderlich. Siehe [[TALSIM Export]].
===Releases starting from 0.9.1===
''Siehe auch [[BlueM Eingabedateien|Eingabedateien]] und [[BlueM Datensätze|Datensätze]]''
For individual simulations, it is easiest to use the '''[[BlueM.Win]]''' package.
* [https://bluemodel.org/download/ Download] the precompiled package <code>BlueM.Win.zip</code> and unzip.
* Start the program '''<code>BlueM.Win.exe</code>'''
* Select a dataset
* Start the simulation
* After successful simulation, view the simulation result in [[Wave]].
 
The computational core (<code>bluem.dll</code>) can be controlled using the API of the [[BlueM.DLLAdapter]].
 
====Using BlueM.Sim with OpenMI====
You need an OMI file, an example of which is provided below:
<source lang="xml">
<LinkableComponent Type="IHWB.BlueM.OpenMIAdapter.BlueM_LinkableComponent" Assembly="D:\BlueM\IHWB.BlueM.OpenMIAdapter.dll">
  <Arguments>
    <Argument Key="FilePath" ReadOnly="true" Value="D:\Dataset\demoNA" />
    <Argument Key="AnzahlInterneZeitschritte" ReadOnly="true" Value="5" />
    <Argument Key="Guetemodell" ReadOnly="true" Value="false" />
    <Argument Key="Guetemodell_Abbauprozess" ReadOnly="true" Value="true" />
    <Argument Key="Guetemodell_Dispersion" ReadOnly="true" Value="false" />
    <Argument Key="Guetemodell_Merge" ReadOnly="true" Value="false" />
    <Argument Key="Simulationsanfang" ReadOnly="true" Value="28.12.1967 00:00" />
  </Arguments>
</LinkableComponent>
</source>
 
The directories have to be modified to point to the correct locations on your computer.


==Simulation==
<u>Explanation of the argument keys:</u>
[[Bild:BlueMWin_screenshot.png|thumb|BlueM.Win Screenshot]]
 
===ab Release 0.9.1===
Location of the dataset (path and filename without ".ALL")
Für einzelne Simulationen ist es am einfachsten, das Paket '''BlueM.Win''' zu nutzen.
<source lang="xml"><Argument Key="FilePath" ReadOnly="true" Value="D:\Dataset\demoNA" /></source>
* Das vorkompilierte Paket [http://130.83.196.154/BlueM/downloads/REL_0_9_1/BlueM.Win.zip BlueM.Win.zip] herunterladen und entpacken.
 
* Die Datei <code>BlueM.Win.exe</code> starten
How many internal timesteps within one OpenMI timestep
* Einen Datensatz auswählen
<source lang="xml"><Argument Key="AnzahlInterneZeitschritte" ReadOnly="true" Value="5" /></source>
* Simulation starten
 
* Nach erfolgreicher Simulation das Simulationsergebnis in Wave anzeigen.<br clear="all"/>
Use the water quality model ([[SWQM]])?
<source lang="xml"><Argument Key="Guetemodell" ReadOnly="true" Value="false" /></source>
 
Use degradation processes in the quality model ?
<source lang="xml"><Argument Key="Guetemodell_Abbauprozess" ReadOnly="true" Value="true" /></source>
 
No effect yet !
<source lang="xml">
<Argument Key="Guetemodell_Dispersion" ReadOnly="true" Value="false" />
<Argument Key="Guetemodell_Merge" ReadOnly="true" Value="false" />
</source>
 
Start date of the simulation:
<source lang="xml"><Argument Key="Simulationsanfang" ReadOnly="true" Value="28.12.1967 00:00" /></source>


===Release 0.9===
===Release 0.9===
[[Bild:BlueMExe_screenshot.png|thumb|BlueM.exe Screenshot]]
[[File:BlueMExe_screenshot.png|thumb|BlueM.exe Screenshot]]
* Im Einfachsten Fall befindet sich die kompilierte EXE-Datei ([[BlueM Downloads|BlueM.exe]]) im gleichen Verzeichnis wie der zu simulierende Datensatz. In diesem Fall wird einfach die EXE gestartet und auf Anforderung der Datensatzname eingegeben. Damit wird die Simulation gestartet.
* In the simplest case the compiled EXE file ([[BlueM Downloads|BlueM.exe]]) is in the same directory as the dataset to be simulated. In this case, simply launch the EXE and then enter the dataset name.
* Man kann den Namen des Datensatzes auch direkt als Übergabeparameter an BlueM.exe übergeben
* You can specify the name of the dataset directly as a parameter to pass to BlueM.exe
:<dos>C:\Arbeitsverzeichnis>"Pfad\zu\BlueM.exe" Datensatzname</dos>
:<pre class="dos">C:\WorkingDir>"path\to\BlueM.exe" datasetname</pre>
* Um zu verhindern, dass sich das Dialogfenster sofort wieder schließt, wenn die Simulation beendet ist oder ein Fehler aufgetreten ist, kann man eine Verknüpfung zu BlueM.exe erstellen. In den Eigenschaften der Verknüpfung, bei "Ziel" folgendes eingeben:
* To prevent the window from closing immediately when the simulation is finished or an error has occurred, a shortcut to BlueM.exe can be created. In the properties of the shortcut enter the following "target":
:<pre>cmd.exe /K "Pfad\zu\BlueM.exe"</pre>
:<pre>cmd.exe /K "path\to\BlueM.exe"</pre>
:Unter "Ausführen in" muss das Arbeitsverzeichnis angegeben werden, d.h. das Verzeichnis, in dem der Datensatz liegt.
:Also, specify the working directory as the directory in which the dataset is located.


==Ergebnisse==
==Results==
* Je nach Einstellung erzeugt BlueM verscheidene Ergebnisdateien. Standardmäßig die [[WEL-Datei]].  
* Depending on the settings, BlueM.Sim creates different result files. By default, the main results are written to a [[WEL-File]].
''Siehe auch [[BlueM Ausgabedateien|Ausgabedateien]]''
''See also [[BlueM Ausgabedateien|output files]]''


===Fehlermeldungen/Warnungen===
===Errors / warnings===
* In manchen Fällen gibt das Blaue Modell bei Programmabbruch eine globale '''[[ERROR-Konstanten | ERROR-Konstante]]''' zurück. (Im Fall das eine '''[[$FEHL.TMP]]''' Datei generiert wird, steht dort auch die ERROR-Konstante in der linken Spalte).
* Errors cause the simulation to stop and must be remedied. All errors are logged to an [[ERR-File|*.ERR file]] in the dataset directory. The *.ERR file contains the date and time of the simulation in the filename and is preserved until deleted by the user. The error messages sometimes contain [[ERROR-Konstanten | error constants]].
* Warnungen (z.B. Speicherüberläufe) werden während der Simulation in die Datei '''[[$WARN.TMP]]''' geschrieben.
* Warnings that occur during the simulation are also logged to a file ([[$WARN.TMP]]), which is deleted each time a new simulation is started.


[[Kategorie:BlueM]]
[[Kategorie: BlueM.Sim Anwendung|A]]
[[Kategorie:BlueM Anwendung|*]]

Latest revision as of 07:53, 3 October 2024

BlueM_icon.png BlueM.Sim | Download | Application | Theory | Development

This page is an aid to the application of BlueM.

Dataset

  • A BlueM.Sim dataset consists of several text files. The minimum requirements are an ALL-File - (general options) and a SYS-File - (System Plan). Furthermore, files for describing the different types of system elements must be included. All files must have the same filename (which is also the name of the dataset), only the file extensions differ. (The name of the dataset should not be longer than 32 characters! See Bug 13)
  • A QGIS plugin for creating BlueM.Sim input files, developed by Martin Grosshaus as part of his Master Thesis, is available on GitHub: https://github.com/bluemodel/BlueM.QGISInterface
  • It is possible to create a dataset using TALSIM, which can then be exported and used for BlueM.Sim. Minor modifications to the export files need to be carried out (see TALSIM Export).

See also Input files

Simulation

BlueM.Win Screenshot

Releases starting from 0.9.1

For individual simulations, it is easiest to use the BlueM.Win package.

  • Download the precompiled package BlueM.Win.zip and unzip.
  • Start the program BlueM.Win.exe
  • Select a dataset
  • Start the simulation
  • After successful simulation, view the simulation result in Wave.

The computational core (bluem.dll) can be controlled using the API of the BlueM.DLLAdapter.

Using BlueM.Sim with OpenMI

You need an OMI file, an example of which is provided below:

<LinkableComponent Type="IHWB.BlueM.OpenMIAdapter.BlueM_LinkableComponent" Assembly="D:\BlueM\IHWB.BlueM.OpenMIAdapter.dll">
  <Arguments>
    <Argument Key="FilePath" ReadOnly="true" Value="D:\Dataset\demoNA" />
    <Argument Key="AnzahlInterneZeitschritte" ReadOnly="true" Value="5" />
    <Argument Key="Guetemodell" ReadOnly="true" Value="false" />
    <Argument Key="Guetemodell_Abbauprozess" ReadOnly="true" Value="true" />
    <Argument Key="Guetemodell_Dispersion" ReadOnly="true" Value="false" />
    <Argument Key="Guetemodell_Merge" ReadOnly="true" Value="false" />
    <Argument Key="Simulationsanfang" ReadOnly="true" Value="28.12.1967 00:00" />
  </Arguments>
</LinkableComponent>

The directories have to be modified to point to the correct locations on your computer.

Explanation of the argument keys:

Location of the dataset (path and filename without ".ALL")

<Argument Key="FilePath" ReadOnly="true" Value="D:\Dataset\demoNA" />

How many internal timesteps within one OpenMI timestep

<Argument Key="AnzahlInterneZeitschritte" ReadOnly="true" Value="5" />

Use the water quality model (SWQM)?

<Argument Key="Guetemodell" ReadOnly="true" Value="false" />

Use degradation processes in the quality model ?

<Argument Key="Guetemodell_Abbauprozess" ReadOnly="true" Value="true" />

No effect yet !

<Argument Key="Guetemodell_Dispersion" ReadOnly="true" Value="false" />
<Argument Key="Guetemodell_Merge" ReadOnly="true" Value="false" />

Start date of the simulation:

<Argument Key="Simulationsanfang" ReadOnly="true" Value="28.12.1967 00:00" />

Release 0.9

BlueM.exe Screenshot
  • In the simplest case the compiled EXE file (BlueM.exe) is in the same directory as the dataset to be simulated. In this case, simply launch the EXE and then enter the dataset name.
  • You can specify the name of the dataset directly as a parameter to pass to BlueM.exe
C:\WorkingDir>"path\to\BlueM.exe" datasetname
  • To prevent the window from closing immediately when the simulation is finished or an error has occurred, a shortcut to BlueM.exe can be created. In the properties of the shortcut enter the following "target":
cmd.exe /K "path\to\BlueM.exe"
Also, specify the working directory as the directory in which the dataset is located.

Results

  • Depending on the settings, BlueM.Sim creates different result files. By default, the main results are written to a WEL-File.

See also output files

Errors / warnings

  • Errors cause the simulation to stop and must be remedied. All errors are logged to an *.ERR file in the dataset directory. The *.ERR file contains the date and time of the simulation in the filename and is preserved until deleted by the user. The error messages sometimes contain error constants.
  • Warnings that occur during the simulation are also logged to a file ($WARN.TMP), which is deleted each time a new simulation is started.