soil_classification_uscs.py
subsurfaceio.functions.soil_classification_uscs
Soil classification functions.
Functions:
| Name | Description |
|---|---|
decorate_coarse_description |
Calculation function. |
decorate_fine_description |
Calculation function. |
get_a_line_position |
Calculation function. |
get_coarse_graded_symbol |
Calculation function. |
get_coarse_group_symbol |
Calculation function. |
get_coarse_symbol |
Calculation function. |
get_description |
Calculation function. |
get_fine_symbol |
Calculation function. |
get_fine_symbol__moreno2018clay |
Calculation function. |
get_soil_classification_uscs__astm2017d2487 |
Calculation function. |
get_symbol |
Calculation function. |
decorate_coarse_description
decorate_coarse_description(
language,
description,
fines_content,
percent_sand,
percent_gravel,
has_organic_fines,
)
Calculation function.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
language
|
str
|
Language |
required |
description
|
str
|
Description |
required |
fines_content
|
float
|
Percentage of fines passing No. 200 sieve |
required |
percent_sand
|
float
|
Sand percentage (% passing No. 4 sieve) |
required |
percent_gravel
|
float
|
Gravel percentage (% retained on No. 4 sieve) |
required |
has_organic_fines
|
bool
|
Indicates if the soil contains organic fines |
required |
Returns:
| Name | Type | Description |
|---|---|---|
uscs_description |
str
|
Unified Soil Classification System description |
decorate_fine_description
Calculation function.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
language
|
str
|
Language |
required |
description
|
str
|
Description |
required |
percent_sand
|
float
|
Sand percentage (% passing No. 4 sieve) |
required |
percent_gravel
|
float
|
Gravel percentage (% retained on No. 4 sieve) |
required |
fine_type
|
str
|
Fine-grained soil type used internally for USCS classification |
required |
Returns:
| Name | Type | Description |
|---|---|---|
uscs_description |
str
|
Unified Soil Classification System description |
get_a_line_position
Calculation function.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
liquid_limit
|
float
|
Liquid limit of soil |
required |
plasticity_index
|
float
|
Plasticity index of soil |
required |
Returns:
| Name | Type | Description |
|---|---|---|
a_line_position |
Any
|
a_line_position |
get_coarse_graded_symbol
Calculation function.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
group_symbol
|
Any
|
group_symbol |
required |
uniformity_coefficient
|
float
|
Uniformity coefficient for particle size distribution |
required |
curvature_coefficient
|
float
|
Curvature coefficient for particle size distribution |
required |
Returns:
| Name | Type | Description |
|---|---|---|
graded_symbol |
Any
|
graded_symbol |
get_coarse_group_symbol
Calculation function.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
percent_sand
|
float
|
Sand percentage (% passing No. 4 sieve) |
required |
percent_gravel
|
float
|
Gravel percentage (% retained on No. 4 sieve) |
required |
Returns:
| Name | Type | Description |
|---|---|---|
group_symbol |
Any
|
group_symbol |
get_coarse_symbol
get_coarse_symbol(
fines_content,
percent_sand,
percent_gravel,
fine_type,
uniformity_coefficient: Any = float("nan"),
curvature_coefficient: Any = float("nan"),
)
Calculation function.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
fines_content
|
float
|
Percentage of fines passing No. 200 sieve |
required |
percent_sand
|
float
|
Sand percentage (% passing No. 4 sieve) |
required |
percent_gravel
|
float
|
Gravel percentage (% retained on No. 4 sieve) |
required |
fine_type
|
str
|
Fine-grained soil type used internally for USCS classification |
required |
uniformity_coefficient
|
float
|
Uniformity coefficient for particle size distribution |
float('nan')
|
curvature_coefficient
|
float
|
Curvature coefficient for particle size distribution |
float('nan')
|
Returns:
| Name | Type | Description |
|---|---|---|
uscs_symbol |
str
|
Unified Soil Classification System symbol |
get_description
get_description(
language,
uscs_symbol,
fines_content,
percent_sand,
percent_gravel,
has_organic_fines,
fine_type,
)
Calculation function.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
language
|
str
|
Language |
required |
uscs_symbol
|
str
|
Unified Soil Classification System symbol |
required |
fines_content
|
float
|
Percentage of fines passing No. 200 sieve |
required |
percent_sand
|
float
|
Sand percentage (% passing No. 4 sieve) |
required |
percent_gravel
|
float
|
Gravel percentage (% retained on No. 4 sieve) |
required |
has_organic_fines
|
bool
|
Indicates if the soil contains organic fines |
required |
fine_type
|
str
|
Fine-grained soil type used internally for USCS classification |
required |
Returns:
| Name | Type | Description |
|---|---|---|
uscs_description |
str
|
Unified Soil Classification System description |
get_fine_symbol
Calculation function.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
liquid_limit
|
float
|
Liquid limit of soil |
required |
plasticity_index
|
float
|
Plasticity index of soil |
required |
has_organic_fines
|
bool
|
Indicates if the soil contains organic fines |
False
|
Returns:
| Name | Type | Description |
|---|---|---|
uscs_symbol |
str
|
Unified Soil Classification System symbol |
fine_type |
str
|
Fine-grained soil type used internally for USCS classification |
get_fine_symbol__moreno2018clay
Calculation function.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
liquid_limit
|
float
|
Liquid limit of soil |
required |
plasticity_index
|
float
|
Plasticity index of soil |
required |
Returns:
| Name | Type | Description |
|---|---|---|
uscs_symbol |
str
|
Unified Soil Classification System symbol |
fine_type |
str
|
Fine-grained soil type used internally for USCS classification |
get_soil_classification_uscs__astm2017d2487
get_soil_classification_uscs__astm2017d2487(
language,
fines_content,
percent_sand,
percent_gravel,
liquid_limit: Any = float("nan"),
plasticity_index: Any = float("nan"),
uniformity_coefficient: Any = float("nan"),
curvature_coefficient: Any = float("nan"),
non_plastic=False,
has_organic_fines=False,
moreno_alonso_plasticity_modification=False,
)
Calculation function.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
language
|
str
|
Language |
required |
fines_content
|
float
|
Percentage of fines passing No. 200 sieve |
required |
percent_sand
|
float
|
Sand percentage (% passing No. 4 sieve) |
required |
percent_gravel
|
float
|
Gravel percentage (% retained on No. 4 sieve) |
required |
liquid_limit
|
float
|
Liquid limit of soil |
float('nan')
|
plasticity_index
|
float
|
Plasticity index of soil |
float('nan')
|
uniformity_coefficient
|
float
|
Uniformity coefficient for particle size distribution |
float('nan')
|
curvature_coefficient
|
float
|
Curvature coefficient for particle size distribution |
float('nan')
|
non_plastic
|
bool
|
Indicates non-plastic soil (PI=0) |
False
|
has_organic_fines
|
bool
|
Indicates if the soil contains organic fines |
False
|
moreno_alonso_plasticity_modification
|
bool
|
Plasticity chart modification per Moreno & Alonso (2018) |
False
|
Returns:
| Name | Type | Description |
|---|---|---|
uscs_symbol |
str
|
Unified Soil Classification System symbol |
uscs_description |
str
|
Unified Soil Classification System description |
get_symbol
get_symbol(
fines_content,
percent_sand,
percent_gravel,
liquid_limit: Any = float("nan"),
plasticity_index: Any = float("nan"),
uniformity_coefficient: Any = float("nan"),
curvature_coefficient: Any = float("nan"),
has_organic_fines=False,
moreno_alonso_plasticity_modification=False,
)
Calculation function.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
fines_content
|
float
|
Percentage of fines passing No. 200 sieve |
required |
percent_sand
|
float
|
Sand percentage (% passing No. 4 sieve) |
required |
percent_gravel
|
float
|
Gravel percentage (% retained on No. 4 sieve) |
required |
liquid_limit
|
float
|
Liquid limit of soil |
float('nan')
|
plasticity_index
|
float
|
Plasticity index of soil |
float('nan')
|
uniformity_coefficient
|
float
|
Uniformity coefficient for particle size distribution |
float('nan')
|
curvature_coefficient
|
float
|
Curvature coefficient for particle size distribution |
float('nan')
|
has_organic_fines
|
bool
|
Indicates if the soil contains organic fines |
False
|
moreno_alonso_plasticity_modification
|
bool
|
Plasticity chart modification per Moreno & Alonso (2018) |
False
|
Returns:
| Name | Type | Description |
|---|---|---|
uscs_symbol |
str
|
Unified Soil Classification System symbol |
fine_type |
str
|
Fine-grained soil type used internally for USCS classification |