pytrnsys_process.api#

Plotting#

pytrnsys_process.api.line_plot

Create a line plot using the provided DataFrame columns.

pytrnsys_process.api.bar_chart

Create a bar chart with multiple columns displayed as grouped bars. The **kwargs are currently not passed on.

pytrnsys_process.api.stacked_bar_chart

Bar chart with stacked bars

pytrnsys_process.api.histogram

Create a histogram from the given DataFrame columns.

pytrnsys_process.api.energy_balance

Create a stacked bar chart showing energy balance with inputs, outputs and imbalance.

pytrnsys_process.api.scatter_plot

Create a scatter plot to show numerical relationships between x and y variables.

pytrnsys_process.api.scalar_compare_plot

Create a scalar comparison plot with up to two grouping variables.

pytrnsys_process.api.get_figure_with_twin_x_axis

Used to make figures with different y axes on the left and right.

Processing#

pytrnsys_process.api.process_single_simulation

Process a single simulation folder using the provided processing step/scenario.

pytrnsys_process.api.process_whole_result_set

Process all simulation folders in a results directory sequentially.

pytrnsys_process.api.process_whole_result_set_parallel

Process all simulation folders in a results directory in parallel.

pytrnsys_process.api.do_comparison

Execute comparison scenarios on processed simulation results.

Data Classes#

pytrnsys_process.api.Simulation

Class representing a TRNSYS simulation with its associated data.

pytrnsys_process.api.SimulationsData

Class representing a result set

Utils#

pytrnsys_process.api.export_plots_in_configured_formats

Save a matplotlib figure in multiple formats and sizes.

pytrnsys_process.api.load_simulations_data_from_pickle

Load SimulationsData from a pickle file.

pytrnsys_process.api.load_simulation_from_pickle

Load a Simulation object from a pickle file.

Settings#

pytrnsys_process.api.global_settings

Class holding the global settings for processing.

pytrnsys_process.api.Defaults

Default settings for different use cases

pytrnsys_process.api.REPO_ROOT

Path subclass for non-Windows systems.