API Reference
The API reference provides detailed descriptions of mosaik’s classes and functions. It should be helpful if you plan to extend mosaik with custom components.
mosaik
— The end-user APImosaik.exceptions
— mosaik specific error typesmosaik.scenario
— Classes related to the scenario creationSimConfig
PythonModel
ConnectModel
CmdModel
World
World.until
World.rt_factor
World.tqdm
World.sim_config
World.config
World.sims
World.time_resolution
World.max_loop_iterations
World.entity_graph
World.sim_progress
World.start
World.connect
World.set_initial_event
World.get_data
World.run
World.cache_triggering_ancestors
World.ensure_no_dataflow_cycles
World.shutdown
ModelFactory
ModelMock
Entity
mosaik.scheduler
— Coordinate and execute simulatorsmosaik.simmanager
— Management of external processesMosaikConfigTotal
start
start_inproc
start_proc
start_connect
Port
SimRunner
SimRunner.rt_start
SimRunner.output_time
SimRunner.data
SimRunner.sid
SimRunner.last_step
SimRunner.next_steps
SimRunner.next_self_step
SimRunner.progress
SimRunner.inputs_from_set_data
SimRunner.persistent_inputs
SimRunner.timed_input_buffer
SimRunner.triggering_ancestors
SimRunner.triggers
SimRunner.output_to_push
SimRunner.pulled_inputs
SimRunner.task
SimRunner.input_delays
SimRunner.schedule_step
SimRunner.stop
MosaikRemote
StarterCollection
TimedInputBuffer
mosaik.util
— Utility classes and functionsmosaik.basic_simulators
— Basic simulators