pytrnsys_process.api.SimulationsData#

class pytrnsys_process.api.SimulationsData(simulations: dict[str, ~pytrnsys_process.process.data_structures.Simulation] = <factory>, scalar: ~pandas.core.frame.DataFrame = <factory>, path_to_simulations: str = <factory>)[source]#

Class representing a result set

Used to do comparisons plots across different simulations

simulations#

Can be accessed using the simulations names as keys. Example: simulations['sim_001']

Type:

dict of {str, Simulation}

scalar#

Contains all deck constant deck values from all simulations. This is also the place to store your calculations for plotting.

Type:

pandas.DataFrame

path_to_simulations#

The path to your results folder

Type:

str

__init__(simulations: dict[str, ~pytrnsys_process.process.data_structures.Simulation] = <factory>, scalar: ~pandas.core.frame.DataFrame = <factory>, path_to_simulations: str = <factory>) None#

Methods

__init__([simulations, scalar, ...])

Attributes

simulations: dict[str, Simulation]#
scalar: DataFrame#
path_to_simulations: str#
path_to_simulations_original: str#
__init__(simulations: dict[str, ~pytrnsys_process.process.data_structures.Simulation] = <factory>, scalar: ~pandas.core.frame.DataFrame = <factory>, path_to_simulations: str = <factory>) None#