The Launcher module
To run a simulation from a Configuration File, the Launcher Module is the main interface you will have to use.
Functionalities
The Launcher allows to :
Run a simulation based on a configuration file
Save results to
.csvor.parquetOrganize results in series folders
Create a basic trace for simulation results
Create a basic trace of the error of the current simulation with a reference file.
Configuration
To use the PhysioBlocks Launcher, you will have to configure a directory where the simulation results are saved. It will also contains your your own nets and blocks as we will see later in this guide.
To configure a directory for the PhysioBlocks launcher, we will have to run the PhysioBlocks Launcher Configure Module. The configure module creates the folder hierarchy and configuration files needed to run the PhysioBlocks Launcher module.
# First, create a new folder dedicated to the PhysioBlocks launcher
# where you want to save your simulation results.
mkdir $MY_PATH/PhysioBlocksLauncher
# Then run the launcher configure module from the created folder
cd $MY_PATH/PhysioBlocksLauncher
python -m physioblocks.launcher.configure -v
The -v option will produce the output:
INFO:root:Launcher directory created at $MYPATH/PhysioBlocksLauncher.
Note
To avoid deleting existing files, the configure module only accepts empty folders. You will get an error message if you try to configure a folder that already contains files.
Alternatively, you can configure a folder at a given path with the -d arguments
# This produce the same result.
python -m physioblocks.launcher.configure -d $MY_PATH/PhysioBlocksLauncher -v
Now that we configured a PhysioBlocks Launcher Folder, the next part will show how to run a simulation and where to find the simulation results.