diff --git a/src/ospx/cli/importSystemStructure.py b/src/ospx/cli/importSystemStructure.py index 4d3ba98c..f87fc67f 100644 --- a/src/ospx/cli/importSystemStructure.py +++ b/src/ospx/cli/importSystemStructure.py @@ -18,7 +18,7 @@ def _argparser() -> argparse.ArgumentParser: epilog="_________________importSystemStructure___________________", prefix_chars="-", add_help=True, - description=("Imports an existing OspSystemStructure.xml and translates it into a caseDict."), + description=("Imports an existing OspSystemStructure.xml and translates it into a case dict file."), ) _ = parser.add_argument( diff --git a/src/ospx/importer.py b/src/ospx/importer.py index 50238b28..24c9e737 100644 --- a/src/ospx/importer.py +++ b/src/ospx/importer.py @@ -16,7 +16,7 @@ class OspSystemStructureImporter: - """Class providing methods to convert an existing OspSystemStructure.xml file to an ospx caseDict file.""" + """Class providing methods to convert an existing OspSystemStructure.xml file to an ospx case dict file.""" @staticmethod def import_system_structure( @@ -24,14 +24,14 @@ def import_system_structure( *, enter_lib_source_as_relative_path: bool = False, ) -> None: - """Import an OspSystemStructure.xml file and save it as an ospx caseDict file. + """Import an OspSystemStructure.xml file and save it as an ospx case dict file. Parameters ---------- system_structure_file : Union[str, os.PathLike[str]] the OspSystemStructure.xml file to be imported enter_lib_source_as_relative_path : bool, optional - whether lib_source shall be entered as relative path in the caseDict, by default False + whether lib_source shall be entered as relative path in the case dict file, by default False Raises ------ diff --git a/src/ospx/ospCaseBuilder.py b/src/ospx/ospCaseBuilder.py index b7849030..1bc8a51b 100644 --- a/src/ospx/ospCaseBuilder.py +++ b/src/ospx/ospCaseBuilder.py @@ -38,7 +38,7 @@ def build( Parameters ---------- case_dict_file : Union[str, os.PathLike[str]] - caseDict file. Contains all case-specific information OspCaseBuilder needs to generate the OSP files. + case dict 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 diff --git a/src/ospx/ospSimulationCase.py b/src/ospx/ospSimulationCase.py index 596c9b32..18be8233 100644 --- a/src/ospx/ospSimulationCase.py +++ b/src/ospx/ospSimulationCase.py @@ -45,9 +45,9 @@ def setup(self) -> None: Raises ------ ValueError - If an expected element in caseDict is missing + If an expected element in the case dict file is missing FileNotFoundError - If an FMU file referenced in caseDict does not exist + If an FMU file referenced in case dict file does not exist """ logger.info(f"Set up OSP simulation case '{self.name}' in case folder: {self.case_folder}") @@ -373,7 +373,7 @@ def write_watch_dict(self) -> None: } # @TODO: Time, StepCount, conn0, conn1, etc from modelDescription.xml ModelVariables - # should match connectors in caseDict for respective model. Improvement needed. + # should match connectors in case dict file for respective model. Improvement needed. # FRALUM, 2021-xx-xx time_column = 0 # Components