Reference

class pycptcore.main.SoilProperties(cpt_table, layer_table, location, verticalPositionReferencePoint, verticalPositionOffset, predrilledDepth, label, groundwaterLevel)[source]

A class for soil properties.

Attributes:

cpt_table: CPTTable

CPT object

layer_table: LayerTable

layer table object

location: Location

spatial object

verticalPositionReferencePoint: str

vertical position reference point

verticalPositionOffset: float

vertical position offset [m w.r.t. reference]

predrilledDepth: float

predrilled depth [m]

label: str

CPT name

groundwaterLevel: float

groundwater level [m]

classmethod from_api_response(response_parse, response_classify=None)[source]

Stores the response of the CPTCore endpoint

Parameters:

  • response_parse (dict) – The resulting response of a call to cpt/parse

  • response_classify (dict | None) – The resulting response of a call to classify/*

Return type:

SoilProperties

plot(figsize=(10.0, 12.0), width_ratios=(1.0, 0.1), **kwargs)[source]

Plots the CPT and soil table data.

Parameters:

  • figsize (Tuple[float, float]) – Size of the activate figure, as the plt.figure() argument.

  • width_ratios (Tuple[float, float]) – Tuple of width-ratios of the subplots, as the plt.GridSpec argument.

  • **kwargs (Any) – All additional keyword arguments are passed to the pyplot.subplots() call.

Returns:

The matplotlib Figure

Return type:

fig

class pycptcore.main.LayerTable(geotechnicalSoilName, lowerBoundary, upperBoundary, color, mainComponent, cohesion, gamma_sat, gamma_unsat, phi, undrainedShearStrength)[source]

Object that contains the Soil-layer data-traces.

Attributes:

geotechnicalSoilName: Sequence[str]

geotechnical Soil Name related to the ISO

lowerBoundary: Sequence[float]

lower boundary of the layer [m]

upperBoundary: Sequence[float]

upper boundary of the layer [m]

color: Sequence[str]

hex color code

mainComponent: Sequence[Literal[“rocks”, “gravel”, “sand”, “silt”, “clay”, “peat”]]

main soil component

cohesion: Sequence[float]

cohesion of the layer [kPa]

gamma_sat: Sequence[float]

Saturated unit weight [kN/m^3]

gamma_unsat: Sequence[float]

unsaturated unit weight [kN/m^3]

phi: Sequence[float]

phi [degrees]

undrainedShearStrength: Sequence[float]

undrained shear strength [kPa]

classmethod from_api_response(response_dict)[source]

Stores the response of the CPTCore endpoint

Parameters:

response_dict (dict) – The resulting response of a call to classify/*

Return type:

LayerTable

property dataframe: DataFrame

The pandas.DataFrame representation

plot(axes=None, offset=0, **kwargs)[source]

Plot the soil-layer in a subplot

Parameters:

  • axes (plt.Axes | None) – plt.Axes object where the data can be plotted on.

  • offset (float) – offset sue to plot upper and lower boundary of the soil layer

  • **kwargs (Any) – All additional keyword arguments are passed to the pyplot.subplots() call.

Return type:

None

class pycptcore.main.CPTTable(penetrationLength, depthOffset, coneResistance, localFriction, frictionRatio)[source]

Object that contains the CPT-related data-traces.

Attributes:

penetrationLength: Sequence[float]

CPT penetrationLength [m]

depthOffset: Sequence[float]

CPT depth [m w.r.t. Reference]

coneResistance: Sequence[float]

cone resistance [Mpa]

localFriction: Sequence[float]

local friction [Mpa]

frictionRatio: Sequence[float]

friction ratio [-]

classmethod from_api_response(response_dict)[source]

Stores the response of the CPTCore endpoint

Parameters:

response_dict (dict) – The resulting response of a call to cpt/parse

Return type:

CPTTable

property dataframe: DataFrame

The pandas.DataFrame representation

plot_cone_resistance(axes=None, offset=0, **kwargs)[source]

Plots the cone resistance.

Parameters:

  • axes (Axes | None) – Optional Axes to plot on.

  • offset (float) – offset used to plot depth

  • **kwargs (Any) – All additional keyword arguments are passed to the pyplot.subplots() call.

Return type:

None

plot_local_friction(axes=None, offset=0, **kwargs)[source]

Plots the local-friction data.

Parameters:

  • axes (Axes | None) – Optional Axes to plot on.

  • offset (float) – offset used to plot depth

  • **kwargs (Any) – All additional keyword arguments are passed to the pyplot.subplots() call.

Return type:

None

plot_friction_ratio(axes=None, offset=0, **kwargs)[source]

Plots the friction-ratio data.

Parameters:

  • axes (Axes | None) – Optional Axes to plot on.

  • offset (float) – offset used to plot depth

  • **kwargs (Any) – All additional keyword arguments are passed to the pyplot.subplots() call.

Return type:

None