rsseismic.types module

Public value types for RSSeismic scripting (protobuf stays internal).

class rsseismic.types.UnitSystem(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

Project unit system (maps to server isMetric / useMetric RPC flags).

Metric = 'Metric'

Imperial = 'Imperial'

to_use_metric() → bool

Return the useMetric / isMetric flag sent on the wire.

classmethod from_is_metric(is_metric: bool) → UnitSystem

class rsseismic.types.ResultMotionType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: IntEnum

Motion variants in the compute-aligned result motion set.

STANDARD = 1

COMPLEMENTARY_EQUIVALENT_LINEAR = 2

COMPLEMENTARY_NONLINEAR_TOTAL_STRESS_LUMPED_MASS = 3

class rsseismic.types.ResultSeriesKind(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: IntEnum

Chart series available from computed profile results.

ACCELERATION = 1

VELOCITY = 2

DISPLACEMENT = 3

ARIAS = 4

SHEAR_STRAIN = 5

SHEAR_STRESS_RATIO = 6

PWP_RATIO = 7

RESPONSE_SPECTRA = 8

FAS = 9

FAS_RATIO = 10

PGA = 11

PGD = 12

MAX_STRAIN = 13

MAX_STRESS = 14

MAX_PWP_RATIO = 15

EFFECTIVE_STRESS = 16

MOBILIZED_STRESS = 17

NORMALIZED_STRESS = 18

MOBILIZED_FRICTION_ANGLE = 19

EFFECTIVE_VERTICAL_STRESS = 20

property requires_layer: bool

True when getResultSeriesDataFrame requires a layerID.

class rsseismic.types.ProfileSummary(name: str, isActive: bool, layerCount: int, totalThickness: float)

Bases: object

Summary of a profile in the project.

name: str

isActive: bool

layerCount: int

totalThickness: float

class rsseismic.types.ActiveProfile(profileName: str, layerCount: int, totalThickness: float)

Bases: object

Summary of the active profile.

profileName: str

layerCount: int

totalThickness: float

class rsseismic.types.SoilLayerSummary(layerID: str, index1Based: int, name: str, thickness: float)

Bases: object

Summary of a soil layer in a profile.

layerID: str

index1Based: int

name: str

thickness: float

class rsseismic.types.BedrockLayerSummary(layerID: str, name: str, thickness: float)

Bases: object

Summary of the bedrock layer in a profile.

layerID: str

name: str

thickness: float

class rsseismic.types.DeleteProfileResult(deletedProfileName: str, activeProfileName: str)

Bases: object

Result of Profiles.deleteProfile().

deletedProfileName: str

activeProfileName: str

class rsseismic.types.MotionInfo(name: str, filePath: str, isSelected: bool)

Bases: object

Ground motion entry for a project.

name: str

filePath: str

isSelected: bool

class rsseismic.types.MotionPairInfo(pairId: str, motionH1Name: str, motionH2Name: str, motionH1FilePath: str, motionH2FilePath: str, isSelected: bool)

Bases: object

Horizontal motion pair inferred from motion file naming.

pairId: str

motionH1Name: str

motionH2Name: str

motionH1FilePath: str

motionH2FilePath: str

isSelected: bool

class rsseismic.types.DeconvolutionLayerResultFiles(layerIndex: int, layerMotionPath: str, layerMotionExists: bool, layerFasTransferFunctionPath: str, layerFasTransferFunctionExists: bool)

Bases: object

Deconvolution output paths for one soil layer.

layerIndex: int

layerMotionPath: str

layerMotionExists: bool

layerFasTransferFunctionPath: str

layerFasTransferFunctionExists: bool

class rsseismic.types.ResultLayerSummary(layerID: str, index1Based: int, name: str, isTopOfRock: bool)

Bases: object

A profile layer that can be used with layer-scoped result queries.

layerID: str

index1Based: int

name: str

isTopOfRock: bool

class rsseismic.types.ResultMotionSummary(motionName: str, motionType: str, sourceMotionName: str)

Bases: object

A motion name in the compute-aligned result motion set.

motionName: str

motionType: str

sourceMotionName: str

class rsseismic.types.ResultDatabaseInfo(profileName: str, motionName: str, motionType: str, resultsFolderPath: str, resultDatabasePath: str, resultDatabaseExists: bool, complementaryResultDatabasePath: str, complementaryResultDatabaseExists: bool, inputFilePath: str, inputFileExists: bool, strainConvergencePath: str, strainConvergenceExists: bool, strainNonConvergenceIdPath: str, strainNonConvergenceExists: bool, deconvolutionBedrockMotionPath: str, deconvolutionBedrockMotionExists: bool, deconvolutionBedrockFasTransferFunctionPath: str, deconvolutionBedrockFasTransferFunctionExists: bool, deconvolutionLayerFiles: tuple[DeconvolutionLayerResultFiles, ...], topOfRockOutputEnabled: bool = False, topOfRockLayerID: str = '', topOfRockLayerIndex1Based: int = 0)

Bases: object

Computed result file paths for one profile/motion pair.

profileName: str

motionName: str

motionType: str

resultsFolderPath: str

resultDatabasePath: str

resultDatabaseExists: bool

complementaryResultDatabasePath: str

complementaryResultDatabaseExists: bool

inputFilePath: str

inputFileExists: bool

strainConvergencePath: str

strainConvergenceExists: bool

strainNonConvergenceIdPath: str

strainNonConvergenceExists: bool

deconvolutionBedrockMotionPath: str

deconvolutionBedrockMotionExists: bool

deconvolutionBedrockFasTransferFunctionPath: str

deconvolutionBedrockFasTransferFunctionExists: bool

deconvolutionLayerFiles: tuple[DeconvolutionLayerResultFiles, ...]

topOfRockOutputEnabled: bool = False

topOfRockLayerID: str = ''

topOfRockLayerIndex1Based: int = 0

class rsseismic.types.InsertLayerResult(profileName: str, layerID: str, index1Based: int)

Bases: object

Result of inserting or duplicating a soil layer.

profileName: str

layerID: str

index1Based: int

class rsseismic.types.AppendLayersResult(profileName: str, layerIDs: tuple[str, ...])

Bases: object

Result of appending one or more soil layers.

profileName: str

layerIDs: tuple[str, ...]

class rsseismic.types.DeleteLayerResult(profileName: str, deletedLayerID: str)

Bases: object

Result of deleting a soil layer.

profileName: str

deletedLayerID: str

class rsseismic.types.MoveLayerResult(profileName: str, layerID: str, index1Based: int)

Bases: object

Result of moving a soil layer.

profileName: str

layerID: str

index1Based: int

class rsseismic.types.GqHFittingLimits(enableModulusMin: bool = False, modulusMin: float = 0.0, enableModulusMax: bool = False, modulusMax: float = 0.0, enableStrengthMin: bool = False, strengthMin: float = 0.0, enableDampMin: bool = False, dampMin: float = 0.0, enableDampMax: bool = False, dampMax: float = 0.0, enableFixTheta3: bool = False, fixTheta3: float = 0.0)

Bases: object

Optional G/Gmax and damping limits for curve fitting.

enableModulusMin: bool = False

modulusMin: float = 0.0

enableModulusMax: bool = False

modulusMax: float = 0.0

enableStrengthMin: bool = False

strengthMin: float = 0.0

enableDampMin: bool = False

dampMin: float = 0.0

enableDampMax: bool = False

dampMax: float = 0.0

enableFixTheta3: bool = False

fixTheta3: float = 0.0

class rsseismic.types.MeanProfileSummary(profileName: str, layerCount: int, totalThickness: float)

Bases: object

Summary of the mean (representative) profile.

profileName: str

layerCount: int

totalThickness: float

class rsseismic.types.MeanProfileInsertLayerResult(layerID: str, index1Based: int)

Bases: object

Result of inserting or duplicating a mean-profile soil layer.

layerID: str

index1Based: int

class rsseismic.types.MeanProfileAppendLayersResult(layerIDs: tuple[str, ...])

Bases: object

Result of appending one or more mean-profile soil layers.

layerIDs: tuple[str, ...]

class rsseismic.types.MeanProfileDeleteLayerResult(deletedLayerID: str)

Bases: object

Result of deleting a mean-profile soil layer.

deletedLayerID: str

class rsseismic.types.MeanProfileMoveLayerResult(layerID: str, index1Based: int)

Bases: object

Result of moving a mean-profile soil layer.

layerID: str

index1Based: int

class rsseismic.types.DynamicsPoint(strain: float, ggmax: float, damping: float, strength: float)

Bases: object

Dynamics curve point (strain, G/Gmax, damping, strength).

strain: float

ggmax: float

damping: float

strength: float

class rsseismic.types.DiscretePoint(strain: float, ggmax: float, damping: float)

Bases: object

Discrete curve point for Points soil model (strain, G/Gmax, damping).

strain: float

ggmax: float

damping: float