Skip to content

Soil classification

subsurfaceio.soil_classification.model

Classes:

Name Description
ReferenceFigureRegistry

Pre-instantiated reference figures
SoilClassification

Soil classification according to USCS, AASHTO and USDA classification systems
SoilClassificationAASHTO

AASHTO classification system model
SoilClassificationUSCS

USCS classification system model
SoilClassificationUSCSGroup

Soil classification according to USCS classification system
SoilClassificationUSDA

USDA classification system model
SoilClassificationUSDAMoreno2018

USDAMoreno2018 classification system model

ReferenceFigureRegistry

Pre-instantiated reference figures

SoilClassification pydantic-model

Bases: Model

Soil classification according to USCS, AASHTO and USDA classification systems

Fields:

model pydantic-field 

model: (
    SoilClassificationUSCS
    | SoilClassificationAASHTO
    | SoilClassificationUSDA
    | SoilClassificationUSDAMoreno2018
)

Soil classification system

results property 

results

Returns the results of the calculation.

calculate 

calculate()

Executes the calculation.

get_calculation_methods classmethod 

get_calculation_methods()

Returns the list of calculation methods associated with this model.

get_reference_figure 

get_reference_figure()

Generates the reference classification figure corresponding to the selected soil classification system.

SoilClassificationAASHTO pydantic-model

Bases: BaseModel

AASHTO classification system model

Fields:

  • system (Literal['AASHTO'])
  • language (Language)
  • fines_content (float)
  • percent_passing_no10 (NullableFloat)
  • percent_passing_no40 (NullableFloat)
  • non_plastic (bool)
  • liquid_limit (NullableFloat)
  • plasticity_index (NullableFloat)

SoilClassificationUSCS pydantic-model

Bases: BaseModel

USCS classification system model

Fields:

  • system (Literal['USCS'])
  • language (Language)
  • has_organic_fines (bool)
  • moreno_alonso_plasticity_modification (bool)
  • fines_content (float)
  • percent_sand (float)
  • percent_gravel (float)
  • non_plastic (bool)
  • liquid_limit (NullableFloat)
  • plasticity_index (NullableFloat)
  • uniformity_coefficient (NullableFloat)
  • curvature_coefficient (NullableFloat)

SoilClassificationUSCSGroup pydantic-model

Bases: Model

Soil classification according to USCS classification system

Fields:

calculate 

calculate()

Executes calculations for each item.

get_calculation_methods classmethod 

get_calculation_methods()

Returns the list of calculation methods associated with this model.

SoilClassificationUSDA pydantic-model

Bases: BaseModel

USDA classification system model

Fields:

  • system (Literal['USDA'])
  • language (Language)
  • percent_sand (float)
  • percent_clay (float)

SoilClassificationUSDAMoreno2018 pydantic-model

Bases: BaseModel

USDAMoreno2018 classification system model

Fields:

  • system (Literal['USDAMoreno2018'])
  • language (Language)
  • percent_sand (float)
  • non_plastic (bool)
  • liquid_limit (NullableFloat)
  • plasticity_index (NullableFloat)