main

api.main

Classes

Name Description
RunExperimentRequest Request payload for running a simulation.
RunExperimentResponse Response payload with simulation results.

RunExperimentRequest

api.main.RunExperimentRequest()

Request payload for running a simulation.

RunExperimentResponse

api.main.RunExperimentResponse()

Response payload with simulation results.

Functions

Name Description
run_experiment Run a simulation experiment and return the results.

run_experiment

api.main.run_experiment(request=Body(...))

Run a simulation experiment and return the results.

The experiment dict should match the YAML schema and is passed directly to SimulationExperiment for initialization.