OspSimulationCase

class ospx.ospSimulationCase.OspSimulationCase(case_dict: SDict[str, Any])

Bases: object

OSP Simulation Case.

__init__(case_dict: SDict[str, Any]) → None

Methods

__init__(case_dict)
setup()	Set up the OSP simulation case folder.
write_osp_system_structure_xml()	Write the OspSystemStructure.xml file.
write_statistics_dict()	Write selected properties of the system structure into a statistics dict.
write_system_structure_ssd()	Write the SystemStructure.ssd file.
write_watch_dict()	Write a case-specific watch dict file.

setup() → None

Set up the OSP simulation case folder.

Raises:

• ValueError – If an expected element in caseDict is missing

• FileNotFoundError – If an FMU file referenced in caseDict does not exist

write_osp_system_structure_xml() → None

Write the OspSystemStructure.xml file.

write_statistics_dict() → None

Write selected properties of the system structure into a statistics dict.

I.e. for documentation or further statistical analysis.

write_system_structure_ssd() → None

Write the SystemStructure.ssd file.

write_watch_dict() → None

Write a case-specific watch dict file.

The watch dict file can be used with watchCosim for

• convergence control

• convergence plotting

• extracting the results