Skip to content

Index

subsurfaceio.reference_data

Published lookup tables used by calculations.

from subsurfaceio.reference_data import ReferenceDataSets

table = ReferenceDataSets.USCSSoilTypes

Classes:

Name Description
ReferenceDataSet

Tabular published values with lookup and grid interpolation.
ReferenceDataSets

Named published tables used by calculations.

ReferenceDataSet

Bases: RecordsList

Tabular published values with lookup and grid interpolation.

Methods:

Name Description
grid_interpolation

Interpolate the table as a 2-D grid.
to_index_map

Map one field onto another across all records.

grid_interpolation 

grid_interpolation(
    index: float | int | ndarray | list,
    column: float | int | ndarray | list,
    index_key: str,
    **interpolation_kwargs: Any
) -> Any

Interpolate the table as a 2-D grid.

All keys except index_key and all values must be numeric. Uses scipy.interpolate.RegularGridInterpolator.

Parameters:

Name Type Description Default
index float | int | ndarray | list

Query location(s) along the first axis (index_key).

 required
column float | int | ndarray | list

Query location(s) along the second axis (other keys).

 required
index_key str

Record key that defines the first grid axis.

 required
**interpolation_kwargs Any

Extra interpolator options. Defaults include method='linear' and bounds_error=False.

 {}

Returns:

Type Description
Any

Interpolated scalar or array from the regular grid.

to_index_map 

to_index_map(
    index_key: str, value_key: str
) -> dict[Any, Any]

Map one field onto another across all records.

Parameters:

Name Type Description Default
index_key str

Record key used as dictionary keys.

 required
value_key str

Record key used as dictionary values.

 required

Returns:

Type Description
dict[Any, Any]

{index_value: corresponding_value} for each record. Later rows overwrite earlier ones when keys collide.

ReferenceDataSets

Named published tables used by calculations.

Methods:

Name Description
as_dict

All catalog tables keyed by attribute name.

Attributes:

Name Type Description
BSSSiteClass ReferenceDataSet
BSSSiteClassOther ReferenceDataSet
Boore04Table2 ReferenceDataSet
Carlton2018Table6 ReferenceDataSet
Carlton2018Table7 ReferenceDataSet
HydrometerDFactor ReferenceDataSet
ModelCoefficientsCetin ReferenceDataSet

cetin2018use Table1
PileFrictionCoefficientBustamante1982 ReferenceDataSet
PileTipResistanceFactorBustamante1982 ReferenceDataSet
PoissonRatioBowles1996 ReferenceDataSet

bowles1996foundation Table 7.2
SoilClassificationSymbology ReferenceDataSet
USCSSoilTypes ReferenceDataSet
UnitSideFrictionCoefficientEslami1997 ReferenceDataSet
UnitSideFrictionLimitBustamante1982 ReferenceDataSet
UnitSideFrictionLimitCareBustamante1982 ReferenceDataSet
UnitWeightCoduto2001 ReferenceDataSet

coduto2001foundation Table 3.2 and AS 4678-2002
UnitWeightOther ReferenceDataSet

BSSSiteClass class-attribute instance-attribute 

BSSSiteClass: ReferenceDataSet = ReferenceDataSet(
    reference_data["BSSSiteClass"]
)

BSSSiteClassOther class-attribute instance-attribute 

BSSSiteClassOther: ReferenceDataSet = ReferenceDataSet(
    reference_data["BSSSiteClassOther"]
)

Boore04Table2 class-attribute instance-attribute 

Boore04Table2: ReferenceDataSet = ReferenceDataSet(
    reference_data["Boore04Table2"]
)

Carlton2018Table6 class-attribute instance-attribute 

Carlton2018Table6: ReferenceDataSet = ReferenceDataSet(
    reference_data["Carlton2018Table6"]
)

Carlton2018Table7 class-attribute instance-attribute 

Carlton2018Table7: ReferenceDataSet = ReferenceDataSet(
    reference_data["Carlton2018Table7"]
)

HydrometerDFactor class-attribute instance-attribute 

HydrometerDFactor: ReferenceDataSet = ReferenceDataSet(
    reference_data["HydrometerDFactor"]
)

ModelCoefficientsCetin class-attribute instance-attribute 

ModelCoefficientsCetin: ReferenceDataSet = ReferenceDataSet(
    reference_data["ModelCoefficientsCetin"]
)

cetin2018use Table1

PileFrictionCoefficientBustamante1982 class-attribute instance-attribute 

PileFrictionCoefficientBustamante1982: ReferenceDataSet = (
    ReferenceDataSet(
        reference_data[
            "PileFrictionCoefficientBustamante1982"
        ]
    )
)

PileTipResistanceFactorBustamante1982 class-attribute instance-attribute 

PileTipResistanceFactorBustamante1982: ReferenceDataSet = (
    ReferenceDataSet(
        reference_data[
            "PileTipResistanceFactorBustamante1982"
        ]
    )
)

PoissonRatioBowles1996 class-attribute instance-attribute 

PoissonRatioBowles1996: ReferenceDataSet = ReferenceDataSet(
    reference_data["PoissonRatioBowles1996"]
)

bowles1996foundation Table 7.2

SoilClassificationSymbology class-attribute instance-attribute 

SoilClassificationSymbology: ReferenceDataSet = (
    ReferenceDataSet(
        reference_data["SoilClassificationSymbology"]
    )
)

USCSSoilTypes class-attribute instance-attribute 

USCSSoilTypes: ReferenceDataSet = ReferenceDataSet(
    reference_data["USCSSoilTypes"]
)

UnitSideFrictionCoefficientEslami1997 class-attribute instance-attribute 

UnitSideFrictionCoefficientEslami1997: ReferenceDataSet = (
    ReferenceDataSet(
        reference_data[
            "UnitSideFrictionCoefficientEslami1997"
        ]
    )
)

UnitSideFrictionLimitBustamante1982 class-attribute instance-attribute 

UnitSideFrictionLimitBustamante1982: ReferenceDataSet = (
    ReferenceDataSet(
        reference_data[
            "UnitSideFrictionLimitBustamante1982"
        ]
    )
)

UnitSideFrictionLimitCareBustamante1982 class-attribute instance-attribute 

UnitSideFrictionLimitCareBustamante1982: (
    ReferenceDataSet
) = ReferenceDataSet(
    reference_data[
        "UnitSideFrictionLimitCareBustamante1982"
    ]
)

UnitWeightCoduto2001 class-attribute instance-attribute 

UnitWeightCoduto2001: ReferenceDataSet = ReferenceDataSet(
    reference_data["UnitWeightCoduto2001"]
)

coduto2001foundation Table 3.2 and AS 4678-2002

UnitWeightOther class-attribute instance-attribute 

UnitWeightOther: ReferenceDataSet = ReferenceDataSet(
    reference_data["UnitWeightOther"]
)

as_dict classmethod 

as_dict() -> dict[str, ReferenceDataSet]

All catalog tables keyed by attribute name.

Returns:

Type Description
dict[str, ReferenceDataSet]

Sorted mapping of dataset name to ReferenceDataSet.