Reference

Cpt

pygef.shim.read_cpt(file, index=0, engine='auto')[source]

Parse the cpt file. Can either be BytesIO, Path or str

Parameters:

  • file (BytesIO | Path | str) – bore file

  • index (int) – only valid for xml files

  • engine (Literal['auto', 'gef', 'xml']) – default is “auto”. parsing engine. Please note that auto engine checks if the files starts with #GEFID.

Return type:

CPTData

class pygef.cpt.CPTData(bro_id, research_report_date, cpt_standard, delivered_location, standardized_location, dissipationtest_performed, quality_class, predrilled_depth, final_depth, groundwater_level, cpt_description, cpt_type, cone_surface_area, cone_diameter, cone_surface_quotient, cone_to_friction_sleeve_distance, cone_to_friction_sleeve_surface_area, cone_to_friction_sleeve_surface_quotient, zlm_cone_resistance_before, zlm_cone_resistance_after, zlm_inclination_ew_before, zlm_inclination_ew_after, zlm_inclination_ns_before, zlm_inclination_ns_after, zlm_inclination_resultant_before, zlm_inclination_resultant_after, zlm_local_friction_before, zlm_local_friction_after, zlm_pore_pressure_u1_before, zlm_pore_pressure_u2_before, zlm_pore_pressure_u3_before, zlm_pore_pressure_u1_after, zlm_pore_pressure_u2_after, zlm_pore_pressure_u3_after, delivered_vertical_position_offset, delivered_vertical_position_datum, delivered_vertical_position_reference_point, data, alias=None)[source]

The CPT dataclass holds the information from the CPT object.

bro_id

BRO ID of the CPT.

Type:

str | None

alias

Alias of the CPT.

Type:

str | None

research_report_date

research report date

Type:

date

delivered_location

delivered location in EPSG:28992 - RD new

Type:

Location

standardized_location

standardized location in EPSG:4326 - WGS 84

Type:

Location | None

delivered_vertical_position_offset

delivered vertical position offset

Type:

float | None

delivered_vertical_position_datum

research delivered vertical position datum

Type:

str

delivered_vertical_position_reference_point

delivered vertical position reference point

Type:

str

cpt_standard

cpt standard

Type:

str | None

dissipationtest_performed

dissipationtest performed

Type:

bool | None

quality_class

quality class

Type:

QualityClass

predrilled_depth

predrilled depth

Type:

float

final_depth

final depth

Type:

float

groundwater_level

groundwater level

Type:

float | None

cpt_description

cpt description

Type:

str

cpt_type

cpt type

Type:

str

cone_surface_area

cone_surface_area

Type:

int

cone_diameter

cone_diameter

Type:

int | None

cone_surface_quotient

cone_surface_quotient

Type:

float | None

cone_to_friction_sleeve_distance

cone_to_friction_sleeve_distance

Type:

int | None

cone_to_friction_sleeve_surface_area

cone_to_friction_sleeve_surface_area

Type:

int | None

cone_to_friction_sleeve_surface_quotient

cone_to_friction_sleeve_surface_quotient

Type:

float | None

zlm_cone_resistance_before

zlm_cone_resistance_before

Type:

float

zlm_cone_resistance_after

zlm_cone_resistance_after

Type:

float

zlm_inclination_ew_before

zlm_inclination_ew_before

Type:

int | None

zlm_inclination_ew_after

zlm_inclination_ew_after

Type:

int | None

zlm_inclination_ns_before

zlm_inclination_ns_before

Type:

int | None

zlm_inclination_ns_after

zlm_inclination_ns_after

Type:

int | None

zlm_inclination_resultant_before

zlm_inclination_resultant_before

Type:

int | None

zlm_inclination_resultant_after

zlm_inclination_resultant_after

Type:

int | None

zlm_local_friction_before

zlm_local_friction_before

Type:

float | None

zlm_local_friction_after

zlm_local_friction_after

Type:

float | None

zlm_pore_pressure_u1_before

zlm_pore_pressure_u1_before

Type:

float | None

zlm_pore_pressure_u2_before

zlm_pore_pressure_u2_before

Type:

float | None

zlm_pore_pressure_u3_before

zlm_pore_pressure_u3_before

Type:

float | None

zlm_pore_pressure_u1_after

zlm_pore_pressure_u1_after

Type:

float | None

zlm_pore_pressure_u2_after

zlm_pore_pressure_u2_after

Type:

float | None

zlm_pore_pressure_u3_after

zlm_pore_pressure_u3_after

Type:

float | None

data

DataFrame columns:

  • penetrationLength [m]

  • coneResistance [MPa]

optional columns:

  • depthOffset [m wrt offset]

    see delivered_vertical_position_datum for offset

  • depth [m]

    penetrationLength corrected for inclination

  • correctedConeResistance [MPa]

  • netConeResistance [MPa]

  • coneResistanceRatio

  • localFriction [MPa]

  • frictionRatioComputed [%]

  • frictionRatio [%]

  • porePressureU1 [MPa]

  • porePressureU2 [MPa]

  • porePressureU3 [MPa]

  • inclinationResultant [degrees]

  • inclinationNS [degrees]

  • inclinationEW [degrees]

  • elapsedTime [seconds]

  • poreRatio [MPa]

  • soilDensity

  • porePressure

  • verticalPorePressureTotal

  • verticalPorePressureEffective

  • temperature [degrees celsius]

  • inclinationX [degrees]

  • inclinationY [degrees]

  • electricalConductivity [S/m]

  • magneticFieldStrengthX [nT]

  • magneticFieldStrengthY [nT]

  • magneticFieldStrengthZ [nT]

  • magneticFieldStrengthTotal [nT]

  • magneticInclination [degrees]

  • magneticDeclination [degrees]

Type:

pl.DataFrame

__init__(bro_id, research_report_date, cpt_standard, delivered_location, standardized_location, dissipationtest_performed, quality_class, predrilled_depth, final_depth, groundwater_level, cpt_description, cpt_type, cone_surface_area, cone_diameter, cone_surface_quotient, cone_to_friction_sleeve_distance, cone_to_friction_sleeve_surface_area, cone_to_friction_sleeve_surface_quotient, zlm_cone_resistance_before, zlm_cone_resistance_after, zlm_inclination_ew_before, zlm_inclination_ew_after, zlm_inclination_ns_before, zlm_inclination_ns_after, zlm_inclination_resultant_before, zlm_inclination_resultant_after, zlm_local_friction_before, zlm_local_friction_after, zlm_pore_pressure_u1_before, zlm_pore_pressure_u2_before, zlm_pore_pressure_u3_before, zlm_pore_pressure_u1_after, zlm_pore_pressure_u2_after, zlm_pore_pressure_u3_after, delivered_vertical_position_offset, delivered_vertical_position_datum, delivered_vertical_position_reference_point, data, alias=None)
property columns: list[str]

Columns names for the DataFrame

property groundwater_level_offset: float | None

groundwater level wrt offset

property predrilled_depth_offset: float | None

predrilled depth wrt offset

property final_depth_offset: float | None

final depth wrt offset

attributes()[source]

Get the attributes

Return type:

dict[str, Any]

display_attributes()[source]

Get pretty formatted string representation of CPTData.attributes`

Return type:

str

pygef.plotting.plot_cpt(data, ax=None, dpi=100, use_offset=False)[source]
Create a plot with three axes.

  • cone_resistance [MPa]

  • friction_ratio [%] (twiny)

  • friction [MPa] (twiny)

Parameters:

  • data (CPTData) – (BoreData) Bore data object

  • ax (Axes | None) – (Axes, optional) Axes object used to add axes

  • dpi (int) – (int, optional) Default is 100 Resolution of the figure.

  • use_offset (bool) – (bool, optional) Default is False Plot depth with respect to offset.

Return type:

Tuple[Axes, Axes, Axes]

Bore

pygef.shim.read_bore(file, index=0, engine='auto')[source]

Parse the bore file. Can either be BytesIO, Path or str

Parameters:

  • file (BytesIO | Path | str) – bore file

  • index (int) – only valid for xml files

  • engine (Literal['auto', 'gef', 'xml']) – default is “auto”. parsing engine. Please note that auto engine checks if the files starts with #GEFID.

Return type:

BoreData

class pygef.bore.BoreData(bro_id, research_report_date, description_procedure, delivered_location, groundwater_level, standardized_location, delivered_vertical_position_offset, delivered_vertical_position_datum, delivered_vertical_position_reference_point, bore_rock_reached, final_bore_depth, final_sample_depth, bore_hole_completed, data, alias=None)[source]

The Bore dataclass holds the information from the BHRgt object.

bro_id

BRO ID of the BHRgt.

Type:

str | None

alias

Alias of the CPT.

Type:

str | None

research_report_date

research report date

Type:

date

delivered_location

delivered location in EPSG:28992 - RD new

Type:

Location

groundwater_level

groundwater level

Type:

float | None

standardized_location

standardized location in EPSG:4326 - WGS 84

Type:

Location | None

delivered_vertical_position_offset

delivered vertical position offset

Type:

float | None

delivered_vertical_position_datum

research delivered vertical position datum

Type:

str

delivered_vertical_position_reference_point

delivered vertical position reference point

Type:

str

bore_rock_reached

bore rock reached

Type:

bool

final_bore_depth

final bore depth

Type:

float

data

DataFrame columns:

  • upperBoundary [m]

  • lowerBoundary [m]

  • geotechnicalSoilName

  • soilDistribution

optional columns:

  • upperBoundaryOffset [m wrt offset]

    see delivered_vertical_position_datum for offset

  • lowerBoundaryOffset [m wrt offset]

    see delivered_vertical_position_datum for offset

  • lutumPercentage [%]

  • siltPercentage [%]

  • sandPercentage [%]

  • gravelPercentage [%]

  • organicMatterPercentage [%]

  • sandMedianClass

  • gravelMedianClass

  • geotechnicalSoilCode

  • color

  • remarks

  • dispersedInhomogeneity

  • organicMatterContentClass

Type:

pl.DataFrame

__init__(bro_id, research_report_date, description_procedure, delivered_location, groundwater_level, standardized_location, delivered_vertical_position_offset, delivered_vertical_position_datum, delivered_vertical_position_reference_point, bore_rock_reached, final_bore_depth, final_sample_depth, bore_hole_completed, data, alias=None)
property columns: list[str]

Columns names for the DataFrame

property groundwater_level_offset: float | None

groundwater level wrt offset

property final_sample_depth_offset: float | None

final sample depth wrt offset

property final_depth_offset: float | None

final depth wrt offset

attributes()[source]

Get the attributes

Return type:

dict[str, Any]

display_attributes()[source]

Get pretty formatted string representation of CPTData.attributes`

Return type:

str

pygef.plotting.plot_bore(data, ax=None, dpi=100, legend=True, use_offset=False)[source]
Create a plot with one axes.

  • soil distribution

Parameters:

  • data (BoreData) – Bore data object

  • ax (Axes | None) – Axes object

  • dpi (int) – Default is 100 Resolution of the figure.

  • legend (bool) – Default is True Add legend to the figure.

  • use_offset (bool) – (bool, optional) Default is False Plot depth with respect to offset.

Return type:

Axes