Skip to content

Index

subsurfaceio.site_investigation.in_situ_tests.mixins

In-situ test calculation mixins and result types.

Classes:

Name Description
CPTFootingCapacityRobertsonResults

CPT Footing Capacity Robertson results.
CPTFootingSettlementsRobertsonResults

CPT Footing Settlements Robertson results.
CPTInterpretationRobertsonResults

CPT Interpretation Robertson results.
CPTLiquefactionBoulanger2014Results

CPT Liquefaction Boulanger 2014 results.
CPTLiquefactionIdriss2008Results

CPT Liquefaction Idriss 2008 results.
CPTLiquefactionRobertsonResults

CPT Liquefaction Robertson results.
CPTLiquefactionSaye2021Results

CPT Liquefaction Saye 2021 results.
CPTPileBustamante1982FelleniusResults

CPT Pile Bustamante 1982 / Fellenius results.
CPTPileBustamante1982Results

CPT Pile Bustamante 1982 results.
CPTPileEslami1997Results

CPT Pile Eslami 1997 results.
CalculationDataMixin

Mixin that assembles depth-aligned inputs for function sequences.
DMTFootingSettlementsRobertsonResults

DMT Footing Settlements Robertson results.
DMTInterpretationMarchettiResults

DMT Interpretation Marchetti results.
DMTLiquefactionMarchettiResults

DMT Liquefaction Marchetti results.
FootingCapacityMixin

Mixin that runs footing capacity calculations on an in-situ test.
FootingSettlementsMixin

Mixin that runs footing settlement calculations on an in-situ test.
InterpretationMixin

Mixin that runs interpretation calculations on an in-situ test.
LaboratoryTestsReportMixin

Mixin that writes an HTML laboratory-tests report for a borehole.
LiquefactionMixin

Mixin that runs liquefaction calculations on an in-situ test.
LiquefactionShearInducedBuildingSettlementBray2017Results

Liquefaction shear-induced building settlement Bray 2017 results.
LiquefactionShearInducedBuildingSettlementMixin

Mixin that runs shear-induced building settlement calculations.
LogPlotMixin

Generate a LogPlot for a single in-situ test (BORH or CPT).
PileMixin

Mixin that runs pile capacity calculations on an in-situ test.
SPTInterpretationResults

SPT Interpretation results.
SPTLiquefactionBoulanger2014Results

SPT Liquefaction Boulanger 2014 results.
SPTLiquefactionCetin2004Results

SPT Liquefaction Cetin 2004 results.
SPTLiquefactionCetin2018Results

SPT Liquefaction Cetin 2018 results.
SPTLiquefactionIdriss2008Results

SPT Liquefaction Idriss 2008 results.

Functions:

Name Description
get_borehole_logplot_data

Build LogPlotData from a borehole test.
get_cpt_logplot_data

Build LogPlotData from a CPT test.

Attributes:

Name Type Description
CPTFootingCapacityRobertsonResultsData
CPTFootingCapacityRobertsonResultsMetadata
CPTFootingSettlementsRobertsonResultsData
CPTFootingSettlementsRobertsonResultsMetadata
CPTInterpretationRobertsonResultsData
CPTLiquefactionBoulanger2014ResultsData
CPTLiquefactionBoulanger2014ResultsMetadata
CPTLiquefactionIdriss2008ResultsData
CPTLiquefactionIdriss2008ResultsMetadata
CPTLiquefactionRobertsonResultsData
CPTLiquefactionRobertsonResultsMetadata
CPTLiquefactionSaye2021ResultsData
CPTLiquefactionSaye2021ResultsMetadata
CPTPileBustamante1982FelleniusResultsData
CPTPileBustamante1982FelleniusResultsMetadata
CPTPileBustamante1982ResultsData
CPTPileBustamante1982ResultsMetadata
CPTPileEslami1997ResultsData
CPTPileEslami1997ResultsMetadata
DMTFootingSettlementsRobertsonResultsData
DMTFootingSettlementsRobertsonResultsMetadata
DMTInterpretationMarchettiResultsData
DMTLiquefactionMarchettiResultsData
DMTLiquefactionMarchettiResultsMetadata
FOOTING_CAPACITY dict[str, type[BaseModel]]

Map of footing-capacity function-sequence name to result model.
FOOTING_SETTLEMENTS dict[str, type[BaseModel]]

Map of footing-settlement function-sequence name to result model.
INTERPRETATION dict[str, type[BaseModel]]

Map of interpretation function-sequence name to result model.
LIQUEFACTION dict[str, type[BaseModel]]

Map of liquefaction function-sequence name to result model.
LIQUEFACTION_SETTLEMENTS dict[str, type[BaseModel]]

Map of shear-induced settlement function-sequence name to result model.
LiquefactionShearInducedBuildingSettlementBray2017ResultsMetadata
PILE_CAPACITY dict[str, type[BaseModel]]

Map of pile-capacity function-sequence name to result model.
SPTInterpretationResultsData
SPTLiquefactionBoulanger2014ResultsData
SPTLiquefactionBoulanger2014ResultsMetadata
SPTLiquefactionCetin2004ResultsData
SPTLiquefactionCetin2004ResultsMetadata
SPTLiquefactionCetin2018ResultsData
SPTLiquefactionCetin2018ResultsMetadata
SPTLiquefactionIdriss2008ResultsData
SPTLiquefactionIdriss2008ResultsMetadata

CPTFootingCapacityRobertsonResultsData module-attribute 

CPTFootingCapacityRobertsonResultsData = create_model(
    "CPTFootingCapacityRobertsonResultsData",
    __base__=BaseModel,
    **as_fields(
        ["depth"]
        + FunctionSequences.CPTFootingCapacityRobertson.return_names(
            scalar=False
        )
    )
)

CPTFootingCapacityRobertsonResultsMetadata module-attribute 

CPTFootingCapacityRobertsonResultsMetadata = create_model(
    "CPTFootingCapacityRobertsonResultsMetadata",
    __base__=BaseModel,
    **as_fields(
        FunctionSequences.CPTFootingCapacityRobertson.return_names(
            scalar=True
        )
    )
)

CPTFootingSettlementsRobertsonResultsData module-attribute 

CPTFootingSettlementsRobertsonResultsData = create_model(
    "CPTFootingSettlementsRobertsonResultsData",
    __base__=BaseModel,
    **as_fields(
        ["depth"]
        + FunctionSequences.CPTFootingSettlementsRobertson.return_names(
            scalar=False
        )
    )
)

CPTFootingSettlementsRobertsonResultsMetadata module-attribute 

CPTFootingSettlementsRobertsonResultsMetadata = create_model(
    "CPTFootingSettlementsRobertsonResultsMetadata",
    __base__=BaseModel,
    **as_fields(
        FunctionSequences.CPTFootingSettlementsRobertson.return_names(
            scalar=True
        )
    )
)

CPTInterpretationRobertsonResultsData module-attribute 

CPTInterpretationRobertsonResultsData = create_model(
    "CPTInterpretationRobertsonResultsData",
    __base__=BaseModel,
    **as_fields(
        ["depth"]
        + FunctionSequences.CPTInterpretationRobertson.return_names(
            scalar=False
        )
    )
)

CPTLiquefactionBoulanger2014ResultsData module-attribute 

CPTLiquefactionBoulanger2014ResultsData = create_model(
    "CPTLiquefactionBoulanger2014ResultsData",
    __base__=BaseModel,
    **as_fields(
        ["depth"]
        + FunctionSequences.CPTLiquefactionBoulanger2014.return_names(
            scalar=False
        )
    )
)

CPTLiquefactionBoulanger2014ResultsMetadata module-attribute 

CPTLiquefactionBoulanger2014ResultsMetadata = create_model(
    "CPTLiquefactionBoulanger2014ResultsMetadata",
    __base__=BaseModel,
    **as_fields(
        FunctionSequences.CPTLiquefactionBoulanger2014.return_names(
            scalar=True
        )
    )
)

CPTLiquefactionIdriss2008ResultsData module-attribute 

CPTLiquefactionIdriss2008ResultsData = create_model(
    "CPTLiquefactionIdriss2008ResultsData",
    __base__=BaseModel,
    **as_fields(
        ["depth"]
        + FunctionSequences.CPTLiquefactionIdriss2008.return_names(
            scalar=False
        )
    )
)

CPTLiquefactionIdriss2008ResultsMetadata module-attribute 

CPTLiquefactionIdriss2008ResultsMetadata = create_model(
    "CPTLiquefactionIdriss2008ResultsMetadata",
    __base__=BaseModel,
    **as_fields(
        FunctionSequences.CPTLiquefactionIdriss2008.return_names(
            scalar=True
        )
    )
)

CPTLiquefactionRobertsonResultsData module-attribute 

CPTLiquefactionRobertsonResultsData = create_model(
    "CPTLiquefactionRobertsonResultsData",
    __base__=BaseModel,
    **as_fields(
        ["depth"]
        + FunctionSequences.CPTLiquefactionRobertson.return_names(
            scalar=False
        )
    )
)

CPTLiquefactionRobertsonResultsMetadata module-attribute 

CPTLiquefactionRobertsonResultsMetadata = create_model(
    "CPTLiquefactionRobertsonResultsMetadata",
    __base__=BaseModel,
    **as_fields(
        FunctionSequences.CPTLiquefactionRobertson.return_names(
            scalar=True
        )
    )
)

CPTLiquefactionSaye2021ResultsData module-attribute 

CPTLiquefactionSaye2021ResultsData = create_model(
    "CPTLiquefactionSaye2021ResultsData",
    __base__=BaseModel,
    **as_fields(
        ["depth"]
        + FunctionSequences.CPTLiquefactionSaye2021.return_names(
            scalar=False
        )
    )
)

CPTLiquefactionSaye2021ResultsMetadata module-attribute 

CPTLiquefactionSaye2021ResultsMetadata = create_model(
    "CPTLiquefactionSaye2021ResultsMetadata",
    __base__=BaseModel,
    **as_fields(
        FunctionSequences.CPTLiquefactionSaye2021.return_names(
            scalar=True
        )
    )
)

CPTPileBustamante1982FelleniusResultsData module-attribute 

CPTPileBustamante1982FelleniusResultsData = create_model(
    "CPTPileBustamante1982FelleniusResultsData",
    __base__=BaseModel,
    **as_fields(
        ["depth"]
        + FunctionSequences.CPTPileBustamante1982Fellenius.return_names(
            scalar=False
        )
    )
)

CPTPileBustamante1982FelleniusResultsMetadata module-attribute 

CPTPileBustamante1982FelleniusResultsMetadata = create_model(
    "CPTPileBustamante1982FelleniusResultsMetadata",
    __base__=BaseModel,
    **as_fields(
        FunctionSequences.CPTPileBustamante1982Fellenius.return_names(
            scalar=True
        )
    )
)

CPTPileBustamante1982ResultsData module-attribute 

CPTPileBustamante1982ResultsData = create_model(
    "CPTPileBustamante1982ResultsData",
    __base__=BaseModel,
    **as_fields(
        ["depth"]
        + FunctionSequences.CPTPileBustamante1982.return_names(
            scalar=False
        )
    )
)

CPTPileBustamante1982ResultsMetadata module-attribute 

CPTPileBustamante1982ResultsMetadata = create_model(
    "CPTPileBustamante1982ResultsMetadata",
    __base__=BaseModel,
    **as_fields(
        FunctionSequences.CPTPileBustamante1982.return_names(
            scalar=True
        )
    )
)

CPTPileEslami1997ResultsData module-attribute 

CPTPileEslami1997ResultsData = create_model(
    "CPTPileEslami1997ResultsData",
    __base__=BaseModel,
    **as_fields(
        ["depth"]
        + FunctionSequences.CPTPileEslami1997.return_names(
            scalar=False
        )
    )
)

CPTPileEslami1997ResultsMetadata module-attribute 

CPTPileEslami1997ResultsMetadata = create_model(
    "CPTPileEslami1997ResultsMetadata",
    __base__=BaseModel,
    **as_fields(
        FunctionSequences.CPTPileEslami1997.return_names(
            scalar=True
        )
    )
)

DMTFootingSettlementsRobertsonResultsData module-attribute 

DMTFootingSettlementsRobertsonResultsData = create_model(
    "DMTFootingSettlementsRobertsonResultsData",
    __base__=BaseModel,
    **as_fields(
        ["depth"]
        + FunctionSequences.DMTFootingSettlementsRobertson.return_names(
            scalar=False
        )
    )
)

DMTFootingSettlementsRobertsonResultsMetadata module-attribute 

DMTFootingSettlementsRobertsonResultsMetadata = create_model(
    "DMTFootingSettlementsRobertsonResultsMetadata",
    __base__=BaseModel,
    **as_fields(
        FunctionSequences.DMTFootingSettlementsRobertson.return_names(
            scalar=True
        )
    )
)

DMTInterpretationMarchettiResultsData module-attribute 

DMTInterpretationMarchettiResultsData = create_model(
    "DMTInterpretationMarchettiResultsData",
    __base__=BaseModel,
    **as_fields(
        ["depth"]
        + FunctionSequences.DMTInterpretationMarchetti.return_names(
            scalar=False
        )
    )
)

DMTLiquefactionMarchettiResultsData module-attribute 

DMTLiquefactionMarchettiResultsData = create_model(
    "DMTLiquefactionMarchettiResultsData",
    __base__=BaseModel,
    **as_fields(
        ["depth"]
        + FunctionSequences.DMTLiquefactionMarchetti.return_names(
            scalar=False
        )
    )
)

DMTLiquefactionMarchettiResultsMetadata module-attribute 

DMTLiquefactionMarchettiResultsMetadata = create_model(
    "DMTLiquefactionMarchettiResultsMetadata",
    __base__=BaseModel,
    **as_fields(
        FunctionSequences.DMTLiquefactionMarchetti.return_names(
            scalar=True
        )
    )
)

FOOTING_CAPACITY module-attribute 

FOOTING_CAPACITY: dict[str, type[BaseModel]] = {
    "CPTFootingCapacityRobertson": CPTFootingCapacityRobertsonResults
}

Map of footing-capacity function-sequence name to result model.

FOOTING_SETTLEMENTS module-attribute 

FOOTING_SETTLEMENTS: dict[str, type[BaseModel]] = {
    "CPTFootingSettlementsRobertson": CPTFootingSettlementsRobertsonResults,
    "DMTFootingSettlementsRobertson": DMTFootingSettlementsRobertsonResults,
}

Map of footing-settlement function-sequence name to result model.

INTERPRETATION module-attribute 

INTERPRETATION: dict[str, type[BaseModel]] = {
    "CPTInterpretationRobertson": CPTInterpretationRobertsonResults,
    "DMTInterpretationMarchetti": DMTInterpretationMarchettiResults,
    "SPTInterpretation": SPTInterpretationResults,
}

Map of interpretation function-sequence name to result model.

LIQUEFACTION module-attribute 

LIQUEFACTION: dict[str, type[BaseModel]] = {
    "SPTLiquefactionCetin2004": SPTLiquefactionCetin2004Results,
    "SPTLiquefactionIdriss2008": SPTLiquefactionIdriss2008Results,
    "SPTLiquefactionBoulanger2014": SPTLiquefactionBoulanger2014Results,
    "SPTLiquefactionCetin2018": SPTLiquefactionCetin2018Results,
    "CPTLiquefactionRobertson": CPTLiquefactionRobertsonResults,
    "CPTLiquefactionIdriss2008": CPTLiquefactionIdriss2008Results,
    "CPTLiquefactionBoulanger2014": CPTLiquefactionBoulanger2014Results,
    "CPTLiquefactionSaye2021": CPTLiquefactionSaye2021Results,
    "DMTLiquefactionMarchetti": DMTLiquefactionMarchettiResults,
}

Map of liquefaction function-sequence name to result model.

LIQUEFACTION_SETTLEMENTS module-attribute 

LIQUEFACTION_SETTLEMENTS: dict[str, type[BaseModel]] = {
    "LiquefactionShearInducedBuildingSettlementBray2017": LiquefactionShearInducedBuildingSettlementBray2017Results
}

Map of shear-induced settlement function-sequence name to result model.

LiquefactionShearInducedBuildingSettlementBray2017ResultsMetadata module-attribute 

LiquefactionShearInducedBuildingSettlementBray2017ResultsMetadata = create_model(
    "LiquefactionShearInducedBuildingSettlementBray2017ResultsMetadata",
    __base__=BaseModel,
    **as_fields(
        FunctionSequences.LiquefactionShearInducedBuildingSettlementBray2017.return_names(
            scalar=True
        )
    )
)

PILE_CAPACITY module-attribute 

PILE_CAPACITY: dict[str, type[BaseModel]] = {
    "CPTPileBustamante1982": CPTPileBustamante1982Results,
    "CPTPileBustamante1982Fellenius": CPTPileBustamante1982FelleniusResults,
    "CPTPileEslami1997": CPTPileEslami1997Results,
}

Map of pile-capacity function-sequence name to result model.

SPTInterpretationResultsData module-attribute 

SPTInterpretationResultsData = create_model(
    "SPTInterpretationResultsData",
    __base__=BaseModel,
    **as_fields(
        ["depth"]
        + FunctionSequences.SPTInterpretation.return_names(
            scalar=False
        )
    )
)

SPTLiquefactionBoulanger2014ResultsData module-attribute 

SPTLiquefactionBoulanger2014ResultsData = create_model(
    "SPTLiquefactionBoulanger2014ResultsData",
    __base__=BaseModel,
    **as_fields(
        ["depth"]
        + FunctionSequences.SPTLiquefactionBoulanger2014.return_names(
            scalar=False
        )
    )
)

SPTLiquefactionBoulanger2014ResultsMetadata module-attribute 

SPTLiquefactionBoulanger2014ResultsMetadata = create_model(
    "SPTLiquefactionBoulanger2014ResultsMetadata",
    __base__=BaseModel,
    **as_fields(
        FunctionSequences.SPTLiquefactionBoulanger2014.return_names(
            scalar=True
        )
    )
)

SPTLiquefactionCetin2004ResultsData module-attribute 

SPTLiquefactionCetin2004ResultsData = create_model(
    "SPTLiquefactionCetin2004ResultsData",
    __base__=BaseModel,
    **as_fields(
        ["depth"]
        + FunctionSequences.SPTLiquefactionCetin2004.return_names(
            scalar=False
        )
    )
)

SPTLiquefactionCetin2004ResultsMetadata module-attribute 

SPTLiquefactionCetin2004ResultsMetadata = create_model(
    "SPTLiquefactionCetin2004ResultsMetadata",
    __base__=BaseModel,
    **as_fields(
        FunctionSequences.SPTLiquefactionCetin2004.return_names(
            scalar=True
        )
    )
)

SPTLiquefactionCetin2018ResultsData module-attribute 

SPTLiquefactionCetin2018ResultsData = create_model(
    "SPTLiquefactionCetin2018ResultsData",
    __base__=BaseModel,
    **as_fields(
        ["depth"]
        + FunctionSequences.SPTLiquefactionCetin2018.return_names(
            scalar=False
        )
    )
)

SPTLiquefactionCetin2018ResultsMetadata module-attribute 

SPTLiquefactionCetin2018ResultsMetadata = create_model(
    "SPTLiquefactionCetin2018ResultsMetadata",
    __base__=BaseModel,
    **as_fields(
        FunctionSequences.SPTLiquefactionCetin2018.return_names(
            scalar=True
        )
    )
)

SPTLiquefactionIdriss2008ResultsData module-attribute 

SPTLiquefactionIdriss2008ResultsData = create_model(
    "SPTLiquefactionIdriss2008ResultsData",
    __base__=BaseModel,
    **as_fields(
        ["depth"]
        + FunctionSequences.SPTLiquefactionIdriss2008.return_names(
            scalar=False
        )
    )
)

SPTLiquefactionIdriss2008ResultsMetadata module-attribute 

SPTLiquefactionIdriss2008ResultsMetadata = create_model(
    "SPTLiquefactionIdriss2008ResultsMetadata",
    __base__=BaseModel,
    **as_fields(
        FunctionSequences.SPTLiquefactionIdriss2008.return_names(
            scalar=True
        )
    )
)

CPTFootingCapacityRobertsonResults pydantic-model

Bases: BaseModel

CPT Footing Capacity Robertson results.

Fields:

data pydantic-field 

data: list[CPTFootingCapacityRobertsonResultsData]

function_sequence pydantic-field 

function_sequence: Literal['CPTFootingCapacityRobertson']

metadata pydantic-field 

metadata: CPTFootingCapacityRobertsonResultsMetadata

CPTFootingSettlementsRobertsonResults pydantic-model

Bases: BaseModel

CPT Footing Settlements Robertson results.

Fields:

data pydantic-field 

data: list[CPTFootingSettlementsRobertsonResultsData]

function_sequence pydantic-field 

function_sequence: Literal["CPTFootingSettlementsRobertson"]

metadata pydantic-field 

metadata: CPTFootingSettlementsRobertsonResultsMetadata

CPTInterpretationRobertsonResults pydantic-model

Bases: BaseModel

CPT Interpretation Robertson results.

Fields:

data pydantic-field 

data: list[CPTInterpretationRobertsonResultsData]

function_sequence pydantic-field 

function_sequence: Literal['CPTInterpretationRobertson']

CPTLiquefactionBoulanger2014Results pydantic-model

Bases: BaseModel

CPT Liquefaction Boulanger 2014 results.

Fields:

data pydantic-field 

data: list[CPTLiquefactionBoulanger2014ResultsData]

function_sequence pydantic-field 

function_sequence: Literal['CPTLiquefactionBoulanger2014']

metadata pydantic-field 

metadata: CPTLiquefactionBoulanger2014ResultsMetadata

CPTLiquefactionIdriss2008Results pydantic-model

Bases: BaseModel

CPT Liquefaction Idriss 2008 results.

Fields:

data pydantic-field 

data: list[CPTLiquefactionIdriss2008ResultsData]

function_sequence pydantic-field 

function_sequence: Literal['CPTLiquefactionIdriss2008']

metadata pydantic-field 

metadata: CPTLiquefactionIdriss2008ResultsMetadata

CPTLiquefactionRobertsonResults pydantic-model

Bases: BaseModel

CPT Liquefaction Robertson results.

Fields:

data pydantic-field 

data: list[CPTLiquefactionRobertsonResultsData]

function_sequence pydantic-field 

function_sequence: Literal['CPTLiquefactionRobertson']

metadata pydantic-field 

metadata: CPTLiquefactionRobertsonResultsMetadata

CPTLiquefactionSaye2021Results pydantic-model

Bases: BaseModel

CPT Liquefaction Saye 2021 results.

Fields:

data pydantic-field 

data: list[CPTLiquefactionSaye2021ResultsData]

function_sequence pydantic-field 

function_sequence: Literal['CPTLiquefactionSaye2021']

metadata pydantic-field 

metadata: CPTLiquefactionSaye2021ResultsMetadata

CPTPileBustamante1982FelleniusResults pydantic-model

Bases: BaseModel

CPT Pile Bustamante 1982 / Fellenius results.

Fields:

data pydantic-field 

data: list[CPTPileBustamante1982FelleniusResultsData]

function_sequence pydantic-field 

function_sequence: Literal["CPTPileBustamante1982Fellenius"]

metadata pydantic-field 

metadata: CPTPileBustamante1982FelleniusResultsMetadata

CPTPileBustamante1982Results pydantic-model

Bases: BaseModel

CPT Pile Bustamante 1982 results.

Fields:

data pydantic-field 

data: list[CPTPileBustamante1982ResultsData]

function_sequence pydantic-field 

function_sequence: Literal['CPTPileBustamante1982']

metadata pydantic-field 

metadata: CPTPileBustamante1982ResultsMetadata

CPTPileEslami1997Results pydantic-model

Bases: BaseModel

CPT Pile Eslami 1997 results.

Fields:

data pydantic-field 

data: list[CPTPileEslami1997ResultsData]

function_sequence pydantic-field 

function_sequence: Literal['CPTPileEslami1997']

metadata pydantic-field 

metadata: CPTPileEslami1997ResultsMetadata

CalculationDataMixin

Mixin that assembles depth-aligned inputs for function sequences.

Methods:

Name Description
get_data_for_calculations

Return calculation inputs as depth-aligned dict-of-lists.

get_data_for_calculations 

get_data_for_calculations() -> dict[str, Any]

Return calculation inputs as depth-aligned dict-of-lists.

DMTFootingSettlementsRobertsonResults pydantic-model

Bases: BaseModel

DMT Footing Settlements Robertson results.

Fields:

data pydantic-field 

data: list[DMTFootingSettlementsRobertsonResultsData]

function_sequence pydantic-field 

function_sequence: Literal["DMTFootingSettlementsRobertson"]

metadata pydantic-field 

metadata: DMTFootingSettlementsRobertsonResultsMetadata

DMTInterpretationMarchettiResults pydantic-model

Bases: BaseModel

DMT Interpretation Marchetti results.

Fields:

data pydantic-field 

data: list[DMTInterpretationMarchettiResultsData]

function_sequence pydantic-field 

function_sequence: Literal['DMTInterpretationMarchetti']

DMTLiquefactionMarchettiResults pydantic-model

Bases: BaseModel

DMT Liquefaction Marchetti results.

Fields:

data pydantic-field 

data: list[DMTLiquefactionMarchettiResultsData]

function_sequence pydantic-field 

function_sequence: Literal['DMTLiquefactionMarchetti']

metadata pydantic-field 

metadata: DMTLiquefactionMarchettiResultsMetadata

FootingCapacityMixin

Mixin that runs footing capacity calculations on an in-situ test.

Methods:

Name Description
calculate_footing_capacity

Run footing capacity and store results on this test.

Attributes:

Name Type Description
footing_capacity CPTFootingCapacityRobertsonResults | None

footing_capacity instance-attribute 

footing_capacity: CPTFootingCapacityRobertsonResults | None

calculate_footing_capacity 

calculate_footing_capacity(
    extra_inputs: dict[str, Any] | None = None,
) -> TCapacity

Run footing capacity and store results on this test.

Parameters:

Name Type Description Default
extra_inputs dict[str, Any] | None

Optional values merged into the function-sequence payload.

 None

Returns:

Type Description
TCapacity

This test, with footing_capacity populated.

FootingSettlementsMixin

Mixin that runs footing settlement calculations on an in-situ test.

Methods:

Name Description
calculate_footing_settlements

Run footing settlement and store results on this test.

Attributes:

Name Type Description
footing_settlements CPTFootingSettlementsRobertsonResults | DMTFootingSettlementsRobertsonResults | None

footing_settlements instance-attribute 

footing_settlements: (
    CPTFootingSettlementsRobertsonResults
    | DMTFootingSettlementsRobertsonResults
    | None
)

calculate_footing_settlements 

calculate_footing_settlements(
    extra_inputs: dict[str, Any] | None = None,
) -> TSettlements

Run footing settlement and store results on this test.

Parameters:

Name Type Description Default
extra_inputs dict[str, Any] | None

Optional values merged into the function-sequence payload.

 None

Returns:

Type Description
TSettlements

This test, with footing_settlements populated.

InterpretationMixin

Mixin that runs interpretation calculations on an in-situ test.

Methods:

Name Description
calculate_interpretation

Run interpretation and store results on this test.

Attributes:

Name Type Description
interpretation CPTInterpretationRobertsonResults | DMTInterpretationMarchettiResults | SPTInterpretationResults | None

interpretation instance-attribute 

interpretation: (
    CPTInterpretationRobertsonResults
    | DMTInterpretationMarchettiResults
    | SPTInterpretationResults
    | None
)

calculate_interpretation 

calculate_interpretation(
    extra_inputs: dict[str, Any] | None = None,
) -> T

Run interpretation and store results on this test.

Parameters:

Name Type Description Default
extra_inputs dict[str, Any] | None

Optional values merged into the function-sequence payload.

 None

Returns:

Type Description
T

This test, with interpretation populated.

LaboratoryTestsReportMixin

Mixin that writes an HTML laboratory-tests report for a borehole.

Methods:

Name Description
write_laboratory_tests_html_report

Write a multi-page HTML report of specimen laboratory tests.

write_laboratory_tests_html_report 

write_laboratory_tests_html_report(
    path: str | Path,
    plot_module: Literal["plotly", "mpl"] = "plotly",
    logo: str | None = None,
) -> Path

Write a multi-page HTML report of specimen laboratory tests.

Parameters:

Name Type Description Default
path str | Path

Output HTML path.

 required
plot_module Literal['plotly', 'mpl']

Figure backend for lab plots.

 'plotly'
logo str | None

Optional logo path passed to the laboratory HTML template.

 None

Returns:

Type Description
Path

The written path.

LiquefactionMixin

Mixin that runs liquefaction calculations on an in-situ test.

Methods:

Name Description
calculate_liquefaction

Run liquefaction triggering and store results on this test.

Attributes:

Name Type Description
liquefaction SPTLiquefactionCetin2004Results | SPTLiquefactionIdriss2008Results | SPTLiquefactionBoulanger2014Results | SPTLiquefactionCetin2018Results | CPTLiquefactionRobertsonResults | CPTLiquefactionIdriss2008Results | CPTLiquefactionBoulanger2014Results | CPTLiquefactionSaye2021Results | DMTLiquefactionMarchettiResults | None

liquefaction instance-attribute 

liquefaction: (
    SPTLiquefactionCetin2004Results
    | SPTLiquefactionIdriss2008Results
    | SPTLiquefactionBoulanger2014Results
    | SPTLiquefactionCetin2018Results
    | CPTLiquefactionRobertsonResults
    | CPTLiquefactionIdriss2008Results
    | CPTLiquefactionBoulanger2014Results
    | CPTLiquefactionSaye2021Results
    | DMTLiquefactionMarchettiResults
    | None
)

calculate_liquefaction 

calculate_liquefaction(
    extra_inputs: dict[str, Any] | None = None,
    calculation_handler: Callable[..., Any] | None = None,
) -> T | Any

Run liquefaction triggering and store results on this test.

When calculation_handler is set, it receives the function sequence and input payload and its return value is returned instead of this test (used by parametric analysis).

Parameters:

Name Type Description Default
extra_inputs dict[str, Any] | None

Optional values merged into the function-sequence payload.

 None
calculation_handler Callable[..., Any] | None

Optional callable (function_sequence, data). When set, results are not stored on this test.

 None

Returns:

Type Description
T | Any

This test with liquefaction populated, or the handler return value when calculation_handler is set.

LiquefactionShearInducedBuildingSettlementBray2017Results pydantic-model

Bases: BaseModel

Liquefaction shear-induced building settlement Bray 2017 results.

Fields:

function_sequence pydantic-field 

function_sequence: Literal[
    "LiquefactionShearInducedBuildingSettlementBray2017"
]

metadata pydantic-field 

metadata: LiquefactionShearInducedBuildingSettlementBray2017ResultsMetadata

LiquefactionShearInducedBuildingSettlementMixin

Mixin that runs shear-induced building settlement calculations.

Methods:

Name Description
calculate_liquefaction_shear_induced_building_settlement

Run Bray 2017 settlement and store results on this test.

Attributes:

Name Type Description
liquefaction_shear_induced_building_settlement LiquefactionShearInducedBuildingSettlementBray2017Results | None

liquefaction_shear_induced_building_settlement instance-attribute 

liquefaction_shear_induced_building_settlement: (
    LiquefactionShearInducedBuildingSettlementBray2017Results
    | None
)

calculate_liquefaction_shear_induced_building_settlement 

calculate_liquefaction_shear_induced_building_settlement(
    extra_inputs: dict[str, Any] | None = None,
) -> T

Run Bray 2017 settlement and store results on this test.

Parameters:

Name Type Description Default
extra_inputs dict[str, Any] | None

Optional values merged into the function-sequence payload.

 None

Returns:

Type Description
T

This test, with liquefaction_shear_induced_building_settlement populated.

Raises:

Type Description
ValueError

When liquefaction results are not present.

LogPlotMixin

Generate a LogPlot for a single in-situ test (BORH or CPT).

Requires a parent site. Default templates are GintBorehole and GintCPT.

Methods:

Name Description
get_logplot

Build and return a LogPlot for this test.

get_logplot 

get_logplot(template_name: str | None = None) -> LogPlot

Build and return a LogPlot for this test.

Parameters:

Name Type Description Default
template_name str | None

Dataset name under LogPlotTemplate. Defaults from test type (GintBorehole / GintCPT).

 None

Returns:

Type Description
LogPlot

LogPlot with data ylim inferred.

PileMixin

Mixin that runs pile capacity calculations on an in-situ test.

Methods:

Name Description
calculate_pile_capacity

Run pile capacity and store results on this test.

Attributes:

Name Type Description
pile_capacity CPTPileBustamante1982Results | CPTPileBustamante1982FelleniusResults | CPTPileEslami1997Results | None

pile_capacity instance-attribute 

pile_capacity: (
    CPTPileBustamante1982Results
    | CPTPileBustamante1982FelleniusResults
    | CPTPileEslami1997Results
    | None
)

calculate_pile_capacity 

calculate_pile_capacity(
    extra_inputs: dict[str, Any] | None = None,
) -> T

Run pile capacity and store results on this test.

Parameters:

Name Type Description Default
extra_inputs dict[str, Any] | None

Optional values merged into the function-sequence payload.

 None

Returns:

Type Description
T

This test, with pile_capacity populated.

SPTInterpretationResults pydantic-model

Bases: BaseModel

SPT Interpretation results.

Fields:

data pydantic-field 

data: list[SPTInterpretationResultsData]

function_sequence pydantic-field 

function_sequence: Literal['SPTInterpretation']

SPTLiquefactionBoulanger2014Results pydantic-model

Bases: BaseModel

SPT Liquefaction Boulanger 2014 results.

Fields:

data pydantic-field 

data: list[SPTLiquefactionBoulanger2014ResultsData]

function_sequence pydantic-field 

function_sequence: Literal['SPTLiquefactionBoulanger2014']

metadata pydantic-field 

metadata: SPTLiquefactionBoulanger2014ResultsMetadata

SPTLiquefactionCetin2004Results pydantic-model

Bases: BaseModel

SPT Liquefaction Cetin 2004 results.

Fields:

data pydantic-field 

data: list[SPTLiquefactionCetin2004ResultsData]

function_sequence pydantic-field 

function_sequence: Literal['SPTLiquefactionCetin2004']

metadata pydantic-field 

metadata: SPTLiquefactionCetin2004ResultsMetadata

SPTLiquefactionCetin2018Results pydantic-model

Bases: BaseModel

SPT Liquefaction Cetin 2018 results.

Fields:

data pydantic-field 

data: list[SPTLiquefactionCetin2018ResultsData]

function_sequence pydantic-field 

function_sequence: Literal['SPTLiquefactionCetin2018']

metadata pydantic-field 

metadata: SPTLiquefactionCetin2018ResultsMetadata

SPTLiquefactionIdriss2008Results pydantic-model

Bases: BaseModel

SPT Liquefaction Idriss 2008 results.

Fields:

data pydantic-field 

data: list[SPTLiquefactionIdriss2008ResultsData]

function_sequence pydantic-field 

function_sequence: Literal['SPTLiquefactionIdriss2008']

metadata pydantic-field 

metadata: SPTLiquefactionIdriss2008ResultsMetadata

get_borehole_logplot_data 

get_borehole_logplot_data(
    test: BoreholeTest,
) -> LogPlotData

Build LogPlotData from a borehole test.

Parameters:

Name Type Description Default
test BoreholeTest

Borehole with strata, samples, and specimens.

 required

Returns:

Type Description
LogPlotData

Log plot data using the default GintBorehole template fields.

get_cpt_logplot_data 

get_cpt_logplot_data(test: CPTTest) -> LogPlotData

Build LogPlotData from a CPT test.

Parameters:

Name Type Description Default
test CPTTest

CPT with tip/sleeve data (friction ratio filled when possible).

 required

Returns:

Type Description
LogPlotData

Log plot data using the default GintCPT template fields.