Scenario API Reference
This is the reference for mosaik’s scenario API, meaning the set of classes and methods that you use to write a scenario (as opposed to connecting a new tool or programming language to mosaik, which would be covered by the simulator API).
This reference should also be helpful if you want to work on or extend mosaik itself.
mosaik— The Scenario APIWorldAsyncWorldAsyncWorld.cache_triggering_ancestorsAsyncWorld.connectAsyncWorld.ensure_no_dataflow_cyclesAsyncWorld.get_dataAsyncWorld.runAsyncWorld.set_initial_eventAsyncWorld.shutdownAsyncWorld.startAsyncWorld.sim_configAsyncWorld.configAsyncWorld.untilAsyncWorld.rt_factorAsyncWorld.time_resolutionAsyncWorld.max_loop_iterationsAsyncWorld.sim_progressAsyncWorld.simsAsyncWorld.entity_graphAsyncWorld.tqdm
mosaik.exceptions— mosaik specific error typesmosaik.scenario— Classes related to the scenario creationmosaik.async_scenario— Using mosaik in an async contextMosaikConfigModelOptionalsPythonModelConnectModelCmdModelSimConfigSimGroupconnect_intervalAsyncWorldAsyncWorld.untilAsyncWorld.rt_factorAsyncWorld.tqdmAsyncWorld.sim_configAsyncWorld.configAsyncWorld.simsAsyncWorld.time_resolutionAsyncWorld.max_loop_iterationsAsyncWorld.entity_graphAsyncWorld.sim_progressAsyncWorld.startAsyncWorld.connectAsyncWorld.set_initial_eventAsyncWorld.get_dataAsyncWorld.runAsyncWorld.cache_triggering_ancestorsAsyncWorld.ensure_no_dataflow_cyclesAsyncWorld.shutdown
MinPathAsyncModelFactoryparse_attrsAsyncModelMockEntity
mosaik.scheduler— Coordinate and execute simulatorsmosaik.simmanager— Management of external processesMosaikConfigTotalstartstart_inprocstart_procstart_connectPortPushDescriptionPullDescriptionSimRunnerSimRunner.rt_startSimRunner.output_timeSimRunner.dataSimRunner.sidSimRunner.last_stepSimRunner.next_stepsSimRunner.next_self_stepSimRunner.progressSimRunner.inputs_from_set_dataSimRunner.persistent_inputsSimRunner.timed_input_bufferSimRunner.successors_to_wait_forSimRunner.successorsSimRunner.triggering_ancestorsSimRunner.triggersSimRunner.output_to_pushSimRunner.pulled_inputsSimRunner.taskSimRunner.input_delaysSimRunner.schedule_stepSimRunner.stop
MosaikRemoteStarterCollectionTimedInputBuffer
mosaik.util— Utility classes and functionsmosaik.basic_simulators— Basic simulators