Skip to content

OQ Hazard

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

OQHazardArgs

Bases: OQArgs

Input for calculating hazard curves.

Parameters:

Name Type Description Default
imts list[str]
required
imtls list[float]
required

Attributes

imts: list[str] instance-attribute

imtls: list[float] instance-attribute

model_config = ConfigDict(arbitrary_types_allowed=True) class-attribute instance-attribute

compatible_calc_id: Annotated[str, AfterValidator(_is_compat_calc_id)] instance-attribute

Identifies hazard run with similar software and settigs such that results can be compared.

nshm_model_version: Annotated[Optional[str], AfterValidator(_is_model_version)] = None class-attribute instance-attribute

An official released NSHM model. Includes logic trees and calculation configuration (i.e. OQ settings).

srm_logic_tree: Optional[SourceLogicTree | Path] = None class-attribute instance-attribute

Seismicity rate model logic tree.

gmcm_logic_tree: Optional[GMCMLogicTree | Path] = None class-attribute instance-attribute

Ground motion model logic tree.

hazard_config: Optional[OpenquakeConfig | Path] = None class-attribute instance-attribute

OpenQuake settings.

vs30: Optional[PositiveInt] = None class-attribute instance-attribute

Uniform site vs30.

locations: Optional[list[str]] = None class-attribute instance-attribute

Location strings as used by nzshm-common.

locations_file: Optional[Path] = None class-attribute instance-attribute

A file with lon, lat locations, and optinoally vs30.

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

A toshi ID of a file with lon, lat locations, and optinoally vs30.

Functions

check_logic_trees() -> Self

abs_path(value: Any, info: ValidationInfo) -> Any classmethod

If any of the fields are paths, resolve the absolute path and check that it exists.

ser_hazard_config(value: Any) -> Any

validate_hazard_config(value: Any) -> Any classmethod

check_locations() -> Self

default_system_args = SystemArgs(task_language=(TaskLanguage.PYTHON), use_api=USE_API, ecs_max_job_time_min=30, ecs_memory=30000, ecs_vcpu=8, ecs_job_definition='BigLever_32GB_8VCPU_v2_JD', ecs_job_queue='BigLever_32GB_8VCPU_v2_JQ') module-attribute