Crustal Inversion

See the base class for inherited parameters and a description of allowed parameter combinations.

CrustalInversionArgs

Bases: InversionArgs

Crustal inversion arguments.

Validators

• If using paleo constraint, must specify all parameters.

Parameters:

Name	Type	Description	Default
spatial_seis_pdf	str | None		None
scaling_c_val	CrustalInversionArgs.ScalingC | None		None
max_mag_type	str		required
mag_range	CrustalInversionArgs.MagRange		required
slip_rate_factor	CrustalInversionArgs.SlipRateFactor		required
paleo_rate_constraint_weight	float | None		None
paleo_parent_rate_smoothness_constraint_weight	float | None		None
paleo_rate_constraint	str | None		None
paleo_probability_model	str | None		None
paleo_rates_file	CrustalInversionArgs.PaleoRatesFile | None		None

Attributes

spatial_seis_pdf: Optional[str] = None class-attribute instance-attribute

scaling_c_val: Optional[ScalingC] = None class-attribute instance-attribute

max_mag_type: str instance-attribute

mag_range: MagRange instance-attribute

slip_rate_factor: SlipRateFactor instance-attribute

paleo_rate_constraint_weight: Optional[float] = None class-attribute instance-attribute

paleo_parent_rate_smoothness_constraint_weight: Optional[float] = None class-attribute instance-attribute

paleo_rate_constraint: Optional[str] = None class-attribute instance-attribute

paleo_probability_model: Optional[str] = None class-attribute instance-attribute

paleo_rates_file: Optional[PaleoRatesFile] = None class-attribute instance-attribute

rupture_set: RuptureSet instance-attribute

initial_solution_id: Optional[str] = None class-attribute instance-attribute

max_inversion_time: float instance-attribute

Maximum time to run inversion in minutes.

completion_energy: float instance-attribute

Completion energy criterion. Ignored if 0.

averaging_threads: Optional[int] = None class-attribute instance-attribute

averaging_interval_secs: int instance-attribute

selector_threads: int instance-attribute

selection_interval_secs: int instance-attribute

perturbation_function: str instance-attribute

cooling_schedule: Optional[str] = None class-attribute instance-attribute

non_negativity_function: str instance-attribute

scaling_relationship: Optional[str] = None class-attribute instance-attribute

Type of scaling relationship, e.g. 'SIMPLE_SUBDUCTION'.

scaling_recalc_mag: Optional[bool] = None class-attribute instance-attribute

Recaculate magnitudes using scaling relationship if True.

deformation_model: str instance-attribute

The fault slip rates, could be FAULT_MODEL which uses rupture set, or some other model.

mfd: MFD instance-attribute

N and b value for both sans and tvz. Subduction only uses sans. tvz is deprecated.

reweight: Optional[bool] = None class-attribute instance-attribute

If True, must also have uncertainty weighting for mfd and slip rate.

mfd_uncertainty_weight: Optional[float] = None class-attribute instance-attribute

Used to when penalizing MFD residuals normalized by uncertainty.

mfd_uncertainty_power: Optional[float] = None class-attribute instance-attribute

Used to when penalizing MFD residuals normalized by uncertainty.

mfd_uncertainty_scalar: Optional[float] = None class-attribute instance-attribute

Used to when penalizing MFD residuals normalized by uncertainty.

mfd_equality_weight: Optional[float] = None class-attribute instance-attribute

Used to penalize MFD residuals in absolute terms (no normalization).

mfd_inequality_weight: Optional[float] = None class-attribute instance-attribute

mfd_eq_ineq_transition_mag: Optional[float] = None class-attribute instance-attribute

Magnitude at which to transition from equality to inequality constraint.

slip_rate_weighting_type: Optional[Literal['BOTH', 'NORMALIZED', 'UNNORMALIZED']] = None class-attribute instance-attribute

Penalize absolute and relative to uncertinaty slip rate residuals.

slip_rate_normalized_weight: Optional[float] = None class-attribute instance-attribute

Penalize absolute and relative to uncertinaty slip rate residuals.

slip_rate_unnormalized_weight: Optional[float] = None class-attribute instance-attribute

Penalize absolute and relative to uncertinaty slip rate residuals.

use_slip_scaling: Optional[bool] = None class-attribute instance-attribute

Penalize slip rate by uncerainty only.

slip_rate_uncertainty_weight: Optional[float] = None class-attribute instance-attribute

Penalize slip rate by uncerainty only.

slip_uncertainty_scaling_factor: Optional[float] = None class-attribute instance-attribute

Penalize slip rate by uncerainty only.

Classes

ScalingC

Bases: BaseModel

Parameters:

Name	Type	Description	Default
dip	float		required
strike	float		required
tag	str		required

Attributes

dip: float instance-attribute

strike: float instance-attribute

tag: str instance-attribute

MagRange

Bases: BaseModel

Parameters:

Name	Type	Description	Default
min_mag_sans	float		required
max_mag_sans	float		required
min_mag_tvz	float		required
max_mag_tvz	float		required

Attributes

min_mag_sans: float instance-attribute

max_mag_sans: float instance-attribute

min_mag_tvz: float instance-attribute

max_mag_tvz: float instance-attribute

SlipRateFactor

Bases: BaseModel

Parameters:

Name	Type	Description	Default
tag	str		required
sans	float		required
tvz	float		required

Attributes

tag: str instance-attribute

sans: float instance-attribute

tvz: float instance-attribute

PaleoRatesFile

Bases: BaseModel

Parameters:

Name	Type	Description	Default
archive_id	str		required
file_name	str		required
tag	str		required

Attributes

archive_id: str instance-attribute

file_name: str instance-attribute

tag: str instance-attribute

MFD

Bases: BaseModel

Parameters:

Name	Type	Description	Default
b	float		required
N	float		required
tag	str		required
enable_tvz	bool		False
b_tvz	float	Not used if enable_tvz is False.	0.0
N_tvz	float	Not used if enable_tvz is False.	0.0

Attributes

b: float instance-attribute

N: float instance-attribute

tag: str instance-attribute

enable_tvz: bool = False class-attribute instance-attribute

b_tvz: float = 0.0 class-attribute instance-attribute

Not used if enable_tvz is False.

N_tvz: float = 0.0 class-attribute instance-attribute

Not used if enable_tvz is False.

RuptureSet

Bases: BaseModel

Parameters:

Name	Type	Description	Default
rupture_set_id	str		required
tag	str		required

Attributes

rupture_set_id: str instance-attribute

tag: str instance-attribute

Functions

check_paleo_constraint() -> Self

If using paleo constraint, must specify all parameters.

check_reweight() -> Self

If re-weighting, must use uncertinaty weighted constraints

check_mfd_constraint() -> Self

Choose either uncertainty weighted or eq/ineq constraints for MFD, not both.

check_mfd_eq_complete() -> Self

If using eq/ineq MFD constraint, must specify all parameters.

check_mfd_unc_complete() -> Self

If using uncertainty weighted MFD constraint, must specify all parameters.

check_slip_constraint() -> Self

Choose either uncertainty weighted or 'regular' slip constraints, not both.

check_slip_abs_complete() -> Self

If using 'regular' slip rate constraint, must specify all parameters.

check_slip_unc_complete() -> Self

If using uncertainty weighted slip rate constraint, must specify all parameters.

get_tasks() -> Generator[Self, None, None]

default_system_args = SystemArgs(task_language=(TaskLanguage.JAVA), use_api=USE_API, java_threads=16, jvm_heap_max=32, ecs_max_job_time_min=60, ecs_memory=30720, ecs_vcpu=4, ecs_job_definition='Fargate-runzi-opensha-JD', ecs_job_queue='BasicFargate_Q') module-attribute