Update docs with the option for user-defining a file with rock properties in... (516acf7d) · Commits · AGS_public / geoloop

docs/manual/lithology_configuration.md

+21 −19

Original line number	Diff line number	Diff line
		@@ -14,9 +14,10 @@ except `config_file_path`.
		The input JSON file for the lithology module includes the following parameters:

		\| Parameter \| Description \| Unit \| Type \| Remark \|
		\|-------------------------\|---------------------------------------------------------------------------------------------\|------\|------\|---------\|
		\|---------------------------\|--------------------------------------------------------------------------------------------\|---------\|----------------\|-----------------------------------------------------------------------------------------\|
		\| input_dir_lithology \| Path to folder with Excel file containing lithology properties for the borehole \| — \| string \| — \|
		\| out_dir_lithology \| Path to folder where lithology output is stored \| — \| string \| Output includes tables with bulk subsurface thermal conductivity over depth and figures \|
		\| lithology_properties_path \| Path to Excel file containing user-defined soil/rock properties \| - \| string \| Optional; default table with properties is included in the lithology package \|
		\| borehole_lithology_path \| Path to Excel file with subsurface lithology data \| — \| string \| — \|
		\| borhole_litho_sheetname \| Name of tab in Excel file with subsurface lithology data \| — \| string \| — \|
		\| out_table \| Name of HDF5 (.h5) file to store lithology and thermal conductivity data \| — \| string \| — \|
		@@ -78,10 +79,11 @@ The lithology types (for `Lithology_a` and `Lithology_b`) currently supported by

		### Excel Format for Lithological Thermal Properties from Literature

		The lithology module relies on an Excel file (`resources/lithology_properties/lithology_properties.xlsx`) that contains
		The lithology module relies on an Excel file (`lithology/resources/lithology_properties.xlsx`) that contains
		physical and thermal parameters for each lithology type, from Hantschel & Kauerauf (2009). This table acts as the reference
		database from which all lithology-dependent thermal-conductivity calculations draw their input values. This table
		should be edited for additional lithologies and/or customization of the rock properties.
		database from which all lithology-dependent thermal-conductivity calculations draw their input values. Optionally,
		the path to a similar table is user-defined in the configuration of the lithology module, with additional or edited soil
		and/or rock properties.

		The Excel file includes the following columns: