Skip to content

Commit

Permalink
Updated docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
langeeri committed Jan 29, 2024
1 parent cd21dc3 commit b6cf0f5
Showing 1 changed file with 0 additions and 20 deletions.
20 changes: 0 additions & 20 deletions src/main.py
Original file line number Diff line number Diff line change
Expand Up @@ -299,13 +299,6 @@ def Initialization(TRNData: Dict[str, Dict[str, List[Union[int, float]]]]) -> No
This function initializes global variable 'servers' by connecting to servers
based on the provided server configurations in SERVER_CONFIGS.
Examples
--------
>>> Initialization(TRNData)
The above example initializes servers using the configuration provided in
'TRNData'.
"""

global servers
Expand Down Expand Up @@ -389,13 +382,6 @@ def EndOfTimeStep(TRNData: Dict[str, Dict[str, List[Union[int, float]]]]) -> Non
This function iterates over connected servers, writes inputs based on the provided
TRNData, and reads outputs if applicable. It logs relevant information during the process.
Examples
--------
>>> EndOfTimeStep(TRNData)
The above example performs end-of-time-step actions on connected servers using the
values provided in 'TRNData'.
"""

try:
Expand Down Expand Up @@ -444,12 +430,6 @@ def LastCallOfSimulation(TRNData: Dict[str, Dict[str, List[Union[int, float]]]])
If an error occurs during the last call of the simulation, an exception is raised.
The error is logged using the logging module.
Examples
--------
>>> trn_data = {'SIMULATION_MODEL': {'outputs': [0, 0, 0]}}
>>> LastCallOfSimulation(trn_data)
>>> # Perform actions at the end of the entire TRNSYS simulation
"""

try:
Expand Down

0 comments on commit b6cf0f5

Please sign in to comment.