Skip to content

Run

RunConfig

Bases: BaseModel, YamlIO

Configuration options during the simulation runtime.

dir_input = '.'

Path to a directory relative to dir_work that will contain input files.

dir_output = '.'

Path to a directory relative to dir_work that the simulation will store output files.

dir_run = '.'

Directory that calculations are performed in. This can be the same as dir_work or some scratch space like $SLURM_SCRATCH.

dir_work = '.'

Working directory during runtime. This can be the current work directory or a workload manager directory such as $SLURM_SUBMIT_DIR.

splits = 1

Split simulation stage into several chunks.

use_scratch = False

Treat dir_run as a scratch directory by copying input files to that location, running the simulation there, and then copying output files back.