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, though in that case, you might also be interested in the developer documentation.
mosaik— The Scenario APImosaik.util— Utility classes and functionsmosaik.exceptions— mosaik specific error typesScenarioErrorSimulationErrorSimulatorErrorNonSerializableOutputsErrorDuplicateEntityIdErrorConnectionClosedErrorSimulatorInitErrorApiVersionTooNewErrorApiVersionMismatchErrorForcedOldApiUsageErrorMissingSimIdErrorMissingSimConfigErrorUnknownStarterNameErrorDuplicateSimIdErrorWeakConnectionOutsideGroupErrorAttributeConnectionErrorConnectErrorDataflowCycleErrorUnknownExtraMethodErrorMissingSimulatorTypeErrorInvalidSimulatorTypeErrorIllegalModelNameErrorIllegalExtraMethodNameErrorSimulatorConnectionLostErrorStepTimeMismatchErrorMaxLoopIterationsExceededErrorInvalidNextStepTypeErrorInvalidNextStepTimeErrorInvalidOutputTimeErrorEventInNonRealTimeModeErrorAsyncRequestsNotConnectedErrorAsyncRequestsNotEnabledErrorUnknownStarterConfigErrorMalformedPythonImportStringErrorPythonImportErrorOutdatedMosaikApiPackageErrorConflictingTerminationManagerErrorProcessStartErrorMalformedConnectAddressErrorSimulatorStartTimeoutErrorSimulatorConnectError
mosaik.scenario— Classes related to the scenario creationmosaik.async_scenario— Using mosaik in an async contextMosaikConfigMosaikConfigTotalModelOptionalsPythonModelConnectModelCmdModelStarterConfigSimConfigSimGroupconnect_intervalAsyncWorldAsyncWorld.untilAsyncWorld.rt_factorAsyncWorld.tqdmAsyncWorld.sim_configAsyncWorld.configAsyncWorld.time_resolutionAsyncWorld.max_loop_iterationsAsyncWorld.entity_graphAsyncWorld.sim_progressAsyncWorld.startAsyncWorld.connect_oneAsyncWorld.connectAsyncWorld.simsAsyncWorld.set_initial_eventAsyncWorld.get_dataAsyncWorld.compileAsyncWorld.runAsyncWorld.cache_triggering_ancestorsAsyncWorld.ensure_no_dataflow_cyclesAsyncWorld.shutdown
MinPathAsyncModelFactoryparse_attrsAsyncModelMockEntity
mosaik.starters— Descriptions of how to start simulatorsmosaik.basic_simulators— Basic simulatorsmosaik.in_or_out_set– Classes for attribute specificationsmosaik.process_termination_managers— control how cmd simulations terminate