biogeme.tools.simulate module

Shortcut to perform simulation of a choice model

Michel Bierlaire Sat Jan 18 11:24:47 2025

biogeme.tools.simulate.simulate(database, dict_of_expressions, estimation_results, csv_filename=None)

Simulate a discrete choice model on a database.

Parameters:

• database (Database) – database

• dict_of_expressions (dict[str, Expression]) – expressions that will be simulated

• estimation_results (EstimationResults) – estimation results.

• csv_filename (str | None) – Name of the output CSV file. If None, no file is generated.

Return type:

DataFrame

Returns:

a pandas data frame with the simulated value. Each row corresponds to a row in the database, and each column to a formula.