pytuflow.ArrEngine#
- class ArrEngine(config, response)#
Bases:
objectAssembles ARR design events (standard or complete storm) for a single site.
The site is defined in a config, uses an already-fetched
ArrApiResponse.- Parameters:
config (ArrConfig) – The ARR configuration to assemble events for.
response (ArrApiResponse) – The ARR Data Hub response for the config’s site, e.g. from
ArrApiClient.fetch().
- __init__(config, response)#
- Parameters:
config (ArrConfig)
response (ArrApiResponse)
- Return type:
None
Methods
Assembles every requested AEP x duration event (and climate change scenario, if enabled) and returns a list of
EventResult.Attributes
Working data captured during
run(), for optional verbose output (seepytuflow.arr.working_data).Extrapolated burst initial loss values (mm), for QA (see
pytuflow.arr.working_data), in the same duration (index) x AEP% (columns) table shape asburst_loss_table, keyed by climate change scenario label (Nonefor the base, no-CC scenario).Raw ARR Data Hub JSON responses and increments CSV text for each
temporal_patterns.additional_tpregion fetched, keyed by (title-cased) region name - populated by_tp_set_for_config(), for optional working-data output (seepytuflow.arr.working_data).