Skip to content

Commit

Permalink
unified naming used in comments from 'caseDict' to 'case dict'
Browse files Browse the repository at this point in the history
  • Loading branch information
ClaasRostock committed Jan 19, 2025
1 parent 2597a61 commit 493b483
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 8 deletions.
2 changes: 1 addition & 1 deletion src/ospx/cli/importSystemStructure.py
Original file line number Diff line number Diff line change
Expand Up @@ -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(
Expand Down
6 changes: 3 additions & 3 deletions src/ospx/importer.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,22 +16,22 @@


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(
system_structure_file: str | os.PathLike[str],
*,
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
------
Expand Down
2 changes: 1 addition & 1 deletion src/ospx/ospCaseBuilder.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 3 additions & 3 deletions src/ospx/ospSimulationCase.py
Original file line number Diff line number Diff line change
Expand Up @@ -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}")

Expand Down Expand Up @@ -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
Expand Down

0 comments on commit 493b483

Please sign in to comment.