2 Running DISPLACE

3 Running DISPLACE via the Graphical User Interface(GUI)

To install on Windows, run the installer (.exe) and follow the on-screen instructions. There are no prerequisites for Windows, and the application should work out of the box. Once the software is installed (find installers on the Drive or on the DISPLACE GUI GitHub or DISPLACE_GUI project page), a DISPLACE simulation can be run after loading a scenario .dat file via Menu>Load (using for example the minimal test dataset that is stored in a public repository), then click Start in the GUI The DISPLACE simulator is then launched on this particular scenario.

4 Running DISPLACE Simulator

The simulator can be lauched also via a command line. This chapter describes the command-line options available when running the DISPLACE simulator. A batch file with some command lines can also be built from the GUI>scheduler.exe for example to generate the batch file that will launch a row of simulations.

For example:

## Generated by Displace Scheduler Editor

start /w C:\displace.exe -a C:\DISPLACE_input_myfish -f "myfish" -f2 "scebaseline" -s "simu1" -i 8762 -p 1 -o 1 -e 1 -v 0 --without-gnuplot -V 1 --num_threads 8

PAUSE

4.1 Command-Line Options

The DISPLACE simulator accepts various command-line arguments to configure its behavior:

4.1.1 Database Options

--indb baseline.db: Reads the data from the specified database file.

4.1.2 Output Options

--outdir C:: Specifies the path where output folders will be created.
--disable-sqlite: Disables output to SQLite database.

4.1.3 Working Directory

-a C:\...\DISPLACE_input_minitest: Specifies the working directory (basepath) where input files are located.

4.1.4 Scenario Configuration

-f "fake": Specifies the first scenario parameter.
--f2 "baseline": Specifies the second scenario parameter (baseline scenario name).
-s "simu1": Sets the simulation name or seed number.

4.1.5 Simulation Parameters

-i 8761: Number of simulation steps to run.
-p 0: Parameter p (deprecated).
-e 1: Parameter e (deprecated).
--huge 1: Enables huge export simulation mode.
-v 0: Verbosity level for output messages (0 = minimal).
-V 1: Alternative verbosity level flag.

4.1.6 Performance Options

--num_threads 4: Number of threads to use for parallel execution.

4.2 Example Usage

# Basic simulation run
displace --indb baseline.db \
  --outdir C:\outputs \
  -a C:\DISPLACE_input_minitest \
  -f "fake" \
  --f2 "baseline" \
  -s "simu1" \
  -i 8761 \
  --num_threads 4

4.3 See Also

Chapter 2 for compilation and setup
Chapter 5 for understanding simulation outputs

--- title: "Running DISPLACE" --- # Running DISPLACE via the Graphical User Interface(GUI) {#sec-running} To install on Windows, run the installer (.exe) and follow the on-screen instructions. There are no prerequisites for Windows, and the application should work out of the box. Once the software is installed (find installers on the Drive or on the [DISPLACE GUI GitHub](https://github.com/frabas/DISPLACE_GUI/releases/) or [DISPLACE_GUI project page](https://displace-project.org/blog/download/)), a DISPLACE simulation can be run after loading a scenario .dat file via Menu>Load (using for example the minimal test dataset that is stored in a [public repository](https://github.com/frabas/DISPLACE_input_minitest)), then click Start in the GUI The DISPLACE simulator is then launched on this particular scenario. # Running DISPLACE Simulator {#sec-running} The simulator can be lauched also via a command line. This chapter describes the command-line options available when running the DISPLACE simulator. A batch file with some command lines can also be built from the GUI>scheduler.exe for example to generate the batch file that will launch a row of simulations. For example: ```sh ## Generated by Displace Scheduler Editor start /w C:\displace.exe -a C:\DISPLACE_input_myfish -f "myfish" -f2 "scebaseline" -s "simu1" -i 8762 -p 1 -o 1 -e 1 -v 0 --without-gnuplot -V 1 --num_threads 8 PAUSE ``` ## Command-Line Options The DISPLACE simulator accepts various command-line arguments to configure its behavior: ### Database Options `--indb baseline.db` : Reads the data from the specified database file. ### Output Options `--outdir C:` : Specifies the path where output folders will be created. `--disable-sqlite` : Disables output to SQLite database. ### Working Directory `-a C:\...\DISPLACE_input_minitest` : Specifies the working directory (basepath) where input files are located. ### Scenario Configuration `-f "fake"` : Specifies the first scenario parameter. `--f2 "baseline"` : Specifies the second scenario parameter (baseline scenario name). `-s "simu1"` : Sets the simulation name or seed number. ### Simulation Parameters `-i 8761` : Number of simulation steps to run. `-p 0` : Parameter p (deprecated). `-e 1` : Parameter e (deprecated). `--huge 1` : Enables huge export simulation mode. `-v 0` : Verbosity level for output messages (0 = minimal). `-V 1` : Alternative verbosity level flag. ### Performance Options `--num_threads 4` : Number of threads to use for parallel execution. ## Example Usage ```bash # Basic simulation run displace --indb baseline.db \ --outdir C:\outputs \ -a C:\DISPLACE_input_minitest \ -f "fake" \ --f2 "baseline" \ -s "simu1" \ -i 8761 \ --num_threads 4 ``` ## See Also - @sec-quickstart for compilation and setup - @sec-output-formats for understanding simulation outputs