PlotInputConfig API Reference

geoloop.configuration.PlotInputConfig

Bases: BaseModel

Configuration object for plotting simulation results.

Controls which simulations to plot, source and output directories, and which quantities or layers to visualize.

Attributes:

Name	Type	Description
`config_file_path`	`Path`	Path to the main configuration file.
`base_dir`	`str or Path`	Directory where results are located that are plotted.
`run_names`	`list of str`	Names of simulation runs to include in plots.
`model_types`	`list of str`	List of model types (ANALYTICAL or FINVOL) corresponding to each simulation.
`run_types`	`list of str`	Run modes(TIN or POWER) for selected simulations.
`run_modes`	`list of str`	Type of simulations to plot (SR for single run or MC for stochastic run).
`plot_names`	`list of str, optional`	Name(s) of simulation(s) that is used in the legend of the plot(s).
`plot_nPipes`	`list of int`	Index of pipe for dataselection to plot.
`plot_layer_k_s`	`list of int`	Index of thermal conductivity layer for dataselection of input parameters to plot.
`plot_layer_kg`	`list of int`	Index of grout thermal conductivity layer for dataselection of input parameters to plot.
`plot_layer_Tg`	`list of int`	Index of subsurface temperature layer for dataselection of input parameters to plot.
`plot_nz`	`list of int`	Index of depth layer for dataselection of results to plot.
`plot_ntime`	`list of int`	Index of timestep for dataselection of results to plot.
`plot_nzseg`	`list of int`	Index of depth segment for dataselection of results to plot.
`plot_times`	`list of float`	Timesteps at which plots should be generated.
`plot_time_depth`	`bool`	Flag that determines whether to generate time– and depth-plots.
`plot_time_parameters`	`list of str, optional`	Time-dependant parameters to plot. Optional. Only used if plot_time_depth is true. Options: dploop; qloop; flowrate; T_fi; T_fo; T_bave; Q_b; COP; Delta_T. With Delta_T = T_fo - T_fi and COP = Q_b/qloop
`plot_depth_parameters`	`list of str, optional`	Depth-dependant parameters to plot. Optional. Only used if plot_time_depth is true. Options: T_b; Tg; T_f; Delta_T
`plot_borehole_temp`	`list of int, optional`	List of depth-segment slice indices to plot borehole temperature for. Only used if plot_time_depth is true. index 0 always works
`plot_crossplot_barplot`	`bool`	Flag that determines whether to create crossplots and barplots. Only compatible with stochastic simulations
`newplot`	`bool`	Flag to plot the simulation(s) listed in run_names seperately or together. Only simulations with the same run_modes can be plot together
`crossplot_vars`	`list of str`	Variable input parameters and results to target in crossplots and tornado plots. Only used if plot_crossplot_barplot is true
`plot_temperature_field`	`bool`	Flag that determines whether to plot full 3D temperature fields. Only used if model_type is FINVOL.

process_config_paths

process_config_paths()

Resolve the base plotting directory.

Uses the config file path to resolve relative paths and ensures the directory exists.

Returns:

Type	Description
`PlotInputConfig`