Skip to content

Index

subsurfaceio.site_design_spectra

Site design spectra API.

Scale a rock spectrum to a soil site:

from subsurfaceio.site_design_spectra import SiteDesignSpectra

SiteDesignSpectra(metadata=metadata, data=rock_spectrum).calculate()

Classes:

Name Description
SiteDesignSpectra

Non-liquefiable NEHRP F site design spectra.
SiteDesignSpectraMetadata

Special-layer inputs for NEHRP F design spectra.
SiteDesignSpectraResults

Design spectrum results.
Spectra

Response spectrum point.

SiteDesignSpectra pydantic-model

Bases: Model

Non-liquefiable NEHRP F site design spectra.

References
  • carlton2018simplified

Fields:

data pydantic-field 

data: list[Spectra]

metadata pydantic-field 

metadata: SiteDesignSpectraMetadata

results pydantic-field 

results: SiteDesignSpectraResults | None = None

calculate 

calculate() -> Self

Run the calculation and store results.

Returns:

Type Description
Self

self with results populated.

get_results_figure 

get_results_figure() -> plotly.graph_objects.Figure

Plot rock and soil design spectra.

Returns:

Type Description
Figure

Plotted reference figure.

Raises:

Type Description
ValueError

If results have not been calculated.

SiteDesignSpectraMetadata pydantic-model

Bases: BaseModel

Special-layer inputs for NEHRP F design spectra.

Fields:

number_of_standard_deviations pydantic-field 

number_of_standard_deviations: float = 0.0

special_cyclic_resistance_ratio_min pydantic-field 

special_cyclic_resistance_ratio_min: float

special_layers_thickness pydantic-field 

special_layers_thickness: float

special_shear_strain_mean pydantic-field 

special_shear_strain_mean: float

special_shear_velocity_mean pydantic-field 

special_shear_velocity_mean: float

SiteDesignSpectraResults pydantic-model

Bases: BaseModel

Design spectrum results.

Fields:

data pydantic-field 

data: list[Spectra]

Spectra pydantic-model

Bases: BaseModel

Response spectrum point.

Fields:

period pydantic-field 

period: float | None = None

pseudo_spectral_acceleration pydantic-field 

pseudo_spectral_acceleration: float | None = None