Skip to content

Commit e30e2a8

Browse files
committed
update of docstrings for ModelExecutionRun and ModelExecutionConfig
1 parent 055dda2 commit e30e2a8

1 file changed

Lines changed: 8 additions & 8 deletions

File tree

OMPython/model_execution.py

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -29,12 +29,11 @@ class ModelExecutionException(Exception):
2929
@dataclasses.dataclass
3030
class ModelExecutionRun:
3131
"""
32-
Data class to store the command line data for running a model executable in the OMC environment.
32+
Data class to store the command line data for running a model executable. This definition is independent of the OMC
33+
environment as only the executable is needed.
3334
34-
All data should be defined for the environment, where OMC is running (local, docker or WSL)
35-
36-
To use this as a definition of an OMC simulation run, it has to be processed within
37-
OMCProcess*.self_update(). This defines the attribute cmd_model_executable.
35+
All data should be defined for the environment, where the executable was defined / is located. This is especially
36+
important if OMPython and the executable are defined in different environments (docker or WSL).
3837
"""
3938
# cmd_path is the expected working directory
4039
cmd_path: str
@@ -107,9 +106,10 @@ def run(self) -> int:
107106

108107
class ModelExecutionConfig:
109108
"""
110-
All information about a compiled model executable. This should include data about all structured parameters, i.e.
111-
parameters which need a recompilation of the model. All non-structured parameters can be easily changed without
112-
the need for recompilation.
109+
This class collects all information about a compiled model executable. This includes data about all structured
110+
parameters, i.e. parameters which need a recompilation of the model. All non-structured parameters can be easily
111+
changed without the need for recompilation. The final result is an instance of class ModelExecutionRun - a
112+
definition to run one simulation based on the compiled model executable.
113113
"""
114114

115115
def __init__(

0 commit comments

Comments
 (0)