Main¶
This module calls the simulator.
The function run_simulations runs the simulations. Its arguments are used to select whether the stochastic version of the tool is to be used, as well as the number of simulations (replications) that should be carried out. Any parameter value can also be changed here, to use values other than the default ones provided.
- CPR.main.run_simulations(inputs, nsim=1, non_stochastic=False, n_jobs=None, **extra_params)¶
This function launches the simulations. Any parameter can be changed using extra_params.
- Parameters
inputs (_io.TextIOWrapper) – csv file
nsim (int, optional) – number of simulations, by default 1
non_stochastic (bool, optional) – deterministic prices and price-rent ratio, by default False
- Returns
instance of the class Results
- Return type