LithologyConfig API Reference

geoloop.configuration.LithologyConfig

Bases: BaseModel

Configuration object for the lithology module.

This class defines the input parameters required for processing borehole lithology data, scaling lithology thermal properties, and generating realizations used in BHE simulations.

Attributes:

Name	Type	Description
config_file_path	str or Path	Path to the JSON configuration file that created this object.
out_dir_lithology	str or Path	Directory where lithology outputs will be written.
lithology_properties_path	str or Path	Path to the Excel table with lithology properties.
borehole_lithology_path	str or Path	Path to the Excel or CSV file containing lithology data.
borehole_lithology_sheetname	str	Name of the sheet inside the Excel file that contains lithologic data.
out_table	str	Filename for the processed lithology table output.
read_from_table	bool	If True, bypass input processing and read from an existing table with thermal conductivity data.
Tg	int or list of int	Surface temperature if int, or subsurface temperature values over depth if list.
Tgrad	int	Geothermal gradient in °C/m.
z_Tg	int or list of int	Depths at which Tg values apply if list.
phi_scale	float	Scaling factor over depth for porosity.
lithology_scale	float	Depth scaling factor for lithology fractions.
lithology_error	float	Random noise scaling applied to lithology fractions.
basecase	bool	If True, disables stochasticity in subsurface properties and returns a deterministic profile.
n_samples	int	Number of stochastic realizations to generate.

process_config_paths

process_config_paths()

Resolve relative paths in the configuration and ensure output directories exist.

Returns:

Type	Description
LithologyConfig	Model with absolute, validated paths.