geolib_plus package

Subpackages

Submodules

geolib_plus.cpt_base_model module

class geolib_plus.cpt_base_model.AbstractCPT(*, penetration_length: ~typing.Optional[~typing.Iterable] = None, depth: ~typing.Optional[~typing.Iterable] = None, coordinates: ~typing.Optional[~typing.List] = None, local_reference_level: ~typing.Optional[float] = None, depth_to_reference: ~typing.Optional[~typing.Iterable] = None, tip: ~typing.Optional[~typing.Iterable] = None, friction: ~typing.Optional[~typing.Iterable] = None, friction_nbr: ~typing.Optional[~typing.Iterable] = None, a: ~typing.Optional[float] = None, name: ~typing.Optional[str] = None, rho: ~typing.Optional[~typing.Iterable] = None, total_stress: ~typing.Optional[~typing.Iterable] = None, effective_stress: ~typing.Optional[~typing.Iterable] = None, pwp: ~typing.Optional[~typing.Iterable] = None, qt: ~typing.Optional[~typing.Iterable] = None, Qtn: ~typing.Optional[~typing.Iterable] = None, Qtncs: ~typing.Optional[~typing.Iterable] = None, Fr: ~typing.Optional[~typing.Iterable] = None, IC: ~typing.Optional[~typing.Iterable] = None, n: ~typing.Optional[~typing.Iterable] = None, vs: ~typing.Optional[~typing.Iterable] = None, G0: ~typing.Optional[~typing.Iterable] = None, E0: ~typing.Optional[~typing.Iterable] = None, permeability: ~typing.Optional[~typing.Iterable] = None, poisson: ~typing.Optional[~typing.Iterable] = None, damping: ~typing.Optional[~typing.Iterable] = None, relative_density: ~typing.Optional[~typing.Iterable] = None, psi: ~typing.Optional[~typing.Iterable] = None, pore_pressure_u1: ~typing.Optional[~typing.Iterable] = None, pore_pressure_u2: ~typing.Optional[~typing.Iterable] = None, pore_pressure_u3: ~typing.Optional[~typing.Iterable] = None, water: ~typing.Optional[~typing.Iterable] = None, lithology: ~typing.Optional[~typing.Iterable] = None, litho_points: ~typing.Optional[~typing.Iterable] = None, lithology_merged: ~typing.Optional[~typing.Iterable] = None, depth_merged: ~typing.Optional[~typing.Iterable] = None, index_merged: ~typing.Optional[~typing.Iterable] = None, vertical_datum: ~typing.Optional[str] = None, local_reference: ~typing.Optional[str] = None, inclination_x: ~typing.Optional[~typing.Iterable] = None, inclination_y: ~typing.Optional[~typing.Iterable] = None, inclination_ns: ~typing.Optional[~typing.Iterable] = None, inclination_ew: ~typing.Optional[~typing.Iterable] = None, inclination_resultant: ~typing.Optional[~typing.Iterable] = None, time: ~typing.Optional[~typing.Iterable] = None, net_tip: ~typing.Optional[~typing.Iterable] = None, pore_ratio: ~typing.Optional[~typing.Iterable] = None, tip_nbr: ~typing.Optional[~typing.Iterable] = None, unit_weight_measured: ~typing.Optional[~typing.Iterable] = None, pwp_ini: ~typing.Optional[~typing.Iterable] = None, total_pressure_measured: ~typing.Optional[~typing.Iterable] = None, effective_pressure_measured: ~typing.Optional[~typing.Iterable] = None, electric_cond: ~typing.Optional[~typing.Iterable] = None, magnetic_strength_x: ~typing.Optional[~typing.Iterable] = None, magnetic_strength_y: ~typing.Optional[~typing.Iterable] = None, magnetic_strength_z: ~typing.Optional[~typing.Iterable] = None, magnetic_strength_tot: ~typing.Optional[~typing.Iterable] = None, magnetic_inclination: ~typing.Optional[~typing.Iterable] = None, magnetic_declination: ~typing.Optional[~typing.Iterable] = None, temperature: ~typing.Optional[~typing.Iterable] = None, predrilled_z: ~typing.Optional[float] = None, undefined_depth: ~typing.Optional[float] = None, cpt_standard: ~typing.Optional[str] = None, quality_class: ~typing.Optional[str] = None, cpt_type: ~typing.Optional[str] = None, result_time: ~typing.Optional[str] = None, water_measurement_type: ~typing.Optional[str] = None, litho_NEN: ~typing.Optional[~typing.Iterable] = None, E_NEN: ~typing.Optional[~typing.Iterable] = None, cohesion_NEN: ~typing.Optional[~typing.Iterable] = None, fr_angle_NEN: ~typing.Optional[~typing.Iterable] = None, plot_settings: ~geolib_plus.plot_settings.PlotSettings = <geolib_plus.plot_settings.PlotSettings object>, g: float = 9.81, Pa: float = 100.0)

Bases: BaseModel

Base CPT class, should define abstract.

E0: Optional[Iterable]
E_NEN: Optional[Iterable]
Fr: Optional[Iterable]
G0: Optional[Iterable]
IC: Optional[Iterable]
Pa: float
Qtn: Optional[Iterable]
Qtncs: Optional[Iterable]
a: Optional[float]
are_data_available_interpretation()
are_data_available_plotting()
calculate_depth()

If depth is present in the cpt and is valid, the depth is parsed from depth elseif resultant inclination angle is present and valid in the cpt, the penetration length is corrected with the inclination angle. if both depth and inclination angle are not present/valid, the depth is parsed from the penetration length. :return:

calculate_friction_nbr_if_not_available()

Calculates friction number if it is not present in the the cpt input file. Friction number is calculated by applying: sleeve friction / cone resistance * 100

check_if_attribute(list_to_be_checked: List, method: str)
check_if_lists_have_the_same_size()
cohesion_NEN: Optional[Iterable]
coordinates: Optional[List]
cpt_standard: Optional[str]
cpt_type: Optional[str]
classmethod create_from(filepath: Path)
damping: Optional[Iterable]
depth: Optional[Iterable]
depth_merged: Optional[Iterable]
depth_to_reference: Optional[Iterable]
abstract drop_duplicate_depth_values()
effective_pressure_measured: Optional[Iterable]
effective_stress: Optional[Iterable]
electric_cond: Optional[Iterable]
fr_angle_NEN: Optional[Iterable]
friction: Optional[Iterable]
friction_nbr: Optional[Iterable]
g: float
abstract classmethod get_cpt_reader() → CptReader
has_duplicated_depth_values()

Check to see if there are any duplicate depth positions in the data :return True if has duplicate depths points based on penetration length

abstract has_points_with_error() → bool
inclination_ew: Optional[Iterable]
inclination_ns: Optional[Iterable]
inclination_resultant: Optional[Iterable]
inclination_x: Optional[Iterable]
inclination_y: Optional[Iterable]
index_merged: Optional[Iterable]
interpret_cpt(method: AbstractInterpretationMethod)
litho_NEN: Optional[Iterable]
litho_points: Optional[Iterable]
lithology: Optional[Iterable]
lithology_merged: Optional[Iterable]
local_reference: Optional[str]
local_reference_level: Optional[float]
magnetic_declination: Optional[Iterable]
magnetic_inclination: Optional[Iterable]
magnetic_strength_tot: Optional[Iterable]
magnetic_strength_x: Optional[Iterable]
magnetic_strength_y: Optional[Iterable]
magnetic_strength_z: Optional[Iterable]
model_config: ClassVar[ConfigDict] = {'arbitrary_types_allowed': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

n: Optional[Iterable]
name: Optional[str]
net_tip: Optional[Iterable]
penetration_length: Optional[Iterable]
perform_pre_drill_interpretation(length_of_average_points: int = 3)

Is performed only if pre-drill exists. Assumes that depth is already defined. If predrill exists it add the average value of tip, friction and friction number to the pre-drill length. The average is computed over the length_of_average_points. If pore water pressure is measured, the pwp is assumed to be zero at surface level. :param : :type : param cpt_BRO: BRO cpt dataset :param : :type : param length_of_average_points: number of samples of the CPT to be used to fill pre-drill :param : :type : return: depth, tip resistance, friction number, friction, pore water pressure

permeability: Optional[Iterable]
plot(directory: Path)
plot_settings: PlotSettings
poisson: Optional[Iterable]
pore_pressure_u1: Optional[Iterable]
pore_pressure_u2: Optional[Iterable]
pore_pressure_u3: Optional[Iterable]
pore_ratio: Optional[Iterable]
pre_process_data()

Standard pre-processes data which is read from a gef file or bro xml file.

Depth is calculated based on available data. Relevant data is corrected for negative values. Pore pressure is retrieved from available data. #todo extend :return:

predrilled_z: Optional[float]
psi: Optional[Iterable]
pwp: Optional[Iterable]
pwp_ini: Optional[Iterable]
qt: Optional[Iterable]
quality_class: Optional[str]
read(filepath: Path)
relative_density: Optional[Iterable]
abstract remove_points_with_error()
result_time: Optional[str]
rho: Optional[Iterable]
temperature: Optional[Iterable]
time: Optional[Iterable]
tip: Optional[Iterable]
tip_nbr: Optional[Iterable]
total_pressure_measured: Optional[Iterable]
total_stress: Optional[Iterable]
undefined_depth: Optional[float]
unit_weight_measured: Optional[Iterable]
static update_value_with_pre_drill(local_depth: Iterable, values: Iterable, length_of_average_points: int) → Iterable

Appends average value defined from length_of_average_points from missing inputs defined from the size of the local depth input.

vertical_datum: Optional[str]
vs: Optional[Iterable]
water: Optional[Iterable]
water_measurement_type: Optional[str]
class geolib_plus.cpt_base_model.AbstractInterpretationMethod

Bases: object

Base Interpretation method for analyzing CPTs.

class geolib_plus.cpt_base_model.CptReader

Bases: object

abstract read_file(filepath: Path) → dict

Module contents