LoadProfileConfig API Reference

geoloop.configuration.LoadProfileConfig

Configuration object for the heat load profile module.

Handles input/output directories and parameters defining the thermal load time-profile used in simulations.

Attributes:

Name	Type	Description
`config_file_path`	`str or Path`	Path to the main JSON configuration file.
`lp_outdir`	`(str or Path, optional)`	Directory for processed load-profile output.
`lp_inputdir`	`(str or Path, optional)`	Directory containing load-profile input files, if type is FROMFILE
`lp_filename`	`(str, optional)`	Name of the input file when type is FROMFILE.
`lp_filepath`	`(str or Path, optional)`	Resolved absolute path to the input file if type is FROMFILE.
`lp_inputcolumn`	`(str, optional)`	Column name to read from the input file, if type is FROMFILE. Default is heating_demand
`lp_type`	`{CONSTANT, VARIABLE, FROMFILE, BERNIER}`	Type of heat load time-profile used.
`lp_base`	`(float or int, optional)`	Base value if type is VARIABLE, constant value if type is CONSTANT.
`lp_peak`	`(float or int, optional)`	Peak value if type is VARIABLE.
`lp_minscaleflow`	`(float or int, optional)`	Minimum scaling factor applied to flow if type is FROMFILE or VARIABLE.
`lp_scale`	`(float or int, optional)`	Scaling factor of the heat laod in the time-profile if type is FROMFILE.
`lp_smoothing`	`(str, optional)`	Smoothing factor applied to the heat load profile if type is FROMFILE.
`lp_minQ`	`(float or int, optional)`	Minimum heat load constraint if type is FROMFILE.

validate_fields()

Validate required fields depending on the selected load-profile type.

Raises:

Type	Description
`ValueError`	If required attributes for the selected `lp_type` are missing.

Returns:

Type	Description
`LoadProfileConfig`	The validated configuration model.

process_config_paths()

Resolve relative paths into absolute paths and create directories as needed.

Updates lp_outdir, lp_inputdir, and lp_filepath based on the location of the main configuration file.

Returns:

Type	Description
`LoadProfileConfig`	The updated instance with resolved paths.