BlueM.Sim application: Difference between revisions

Revision as of 09:03, 30 July 2009

BlueM.Sim | Downloads | 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)
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

Release 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 from another application using the BlueM.DLLAdapter.

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

<dos>C:\WorkingDir>"Path\to\BlueM.exe" datasetname</dos>

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"

Under "Start in" the working directory must be specified, i.e., 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.

@@ Line 3: / Line 3: @@
 This page is an aid to the application of BlueM.
-==Record==
+==Dataset==
-* A record consists of several text files. Mandatory for each simulation are [[TSIM.ALL|ALL]]- (general information) and the [[TSIM.SYS|SYS]] file - (System Plan). Furthermore, files for a description of the system elements should be in the required manner. All files must have the same file name (name = record), only the file extensions differ. <small>(The name of the record shall consist of not more than 32 characters! ''See Bug 13'')</small>
+* 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>
-* It is possible to make a record using [[TALSIM]], after creating these can be exported and used for BlueM. These are minor modifications to the export files. See [[TALSIM Export]].
+* 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]]''
 ==Simulation==
-[[Bild:BlueMWin_screenshot.png|thumb|BlueM.Win Screenshot]]
+[[File:BlueMWin_screenshot.png|thumb|BlueM.Win Screenshot]]
 ===Release 0.9.1===
 For individual simulations, it is easiest to use the '''[[BlueM.Win]]''' package.
-* [[BlueM Downloads|Download]] the prebuilt package <code>BlueM.Win.zip</code>  and unzip.
+* [[BlueM Downloads|Download]] the precompiled package <code>BlueM.Win.zip</code>  and unzip.
-* Start the file <code>BlueM.Win.exe</code>
+* Start the program <code>BlueM.Win.exe</code>
-* Select a record
+* Select a dataset
-* Start simulation
+* Start the simulation
-* After successful simulation, view the simulation result in BlueM.Wave.
+* After successful simulation, view the simulation result in [[Wave]].
-For <code>bluem.dll</code> from another application address, the [[BlueM.DLLAdapter]] can be used.<br clear="all"/>
+The computational core (<code>bluem.dll</code>) can be controlled from another application using the [[BlueM.DLLAdapter]].<br clear="all"/>
 ===Release 0.9===
-[[Bild:BlueMExe_screenshot.png|thumb|BlueM.exe Screenshot]]
+[[File:BlueMExe_screenshot.png|thumb|BlueM.exe Screenshot]]
-* In the simplest case the compiled EXE file ([[BlueM Downloads|BlueM.exe]]) is in the same directory as the data to be simulated. In this case, simply launch the EXE at the request of the record name. Then the simulation starts.
+* 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.
-* You can specify the name of the data directly as a parameter to pass to BlueM.exe
+* 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>
+:<dos>C:\WorkingDir>"Path\to\BlueM.exe" datasetname</dos>
-* 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" :
+* 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>
-:Under "Start in" the working directory must be specified, i.e., the directory in which the record is located.
+:Under "Start in" the working directory must be specified, i.e., the directory in which the dataset is located.
 ==Results==
-* Depending on the setting BlueM creates different result files. By default, the main results are written to a [[WEL-Format|WEL file]].
+* Depending on the settings, BlueM.Sim creates different result files. By default, the main results are written to a [[WEL-File]].
 ''See also [[BlueM Ausgabedateien|output files]]''