OspCaseBuilder

class ospx.ospCaseBuilder.OspCaseBuilder

Bases: object

Builder for OSP-specific configuration files needed to run an OSP (co-)simulation case.

__init__() → None

Methods

__init__()

build(case_dict_file, *[, inspect, graph, clean])

Build the OSP-specific configuration files needed to run an OSP (co-)simulation case.
static build(case_dict_file: str | PathLike[str], *, inspect: bool = False, graph: bool = False, clean: bool = False) → None

Build the OSP-specific configuration files needed to run an OSP (co-)simulation case.

Builds following files:

  • OspSystemStructure.xml

  • SystemStructure.ssd

  • Plot.json

  • statisticsDict

  • watchDict

Parameters:

  • case_dict_file (Union[str, os.PathLike[str]]) – caseDict file. Contains all case-specific information OspCaseBuilder needs to generate the OSP files.

  • inspect (bool, optional) – inspect mode. If True, build() reads all properties from the FMUs but does not actually create the OSP case files, by default False

  • graph (bool, optional) – if True, creates a dependency graph image using graphviz, by default False

  • clean (bool, optional) – if True, cleans up case folder and deletes any formerly created ospx files, e.g. OspSystemStructure.xml .fmu .csv etc.

Raises:

FileNotFoundError – if case_dict_file does not exist