pytuflow.ArrEngine

pytuflow.ArrEngine#

class ArrEngine(config, response)#

Bases: object

Assembles 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

run

Assembles every requested AEP x duration event (and climate change scenario, if enabled) and returns a list of EventResult.

Attributes

config

response

arf_tables

Working data captured during run(), for optional verbose output (see pytuflow.arr.working_data).

depth_areal_tables

burst_loss_table

extrapolated_loss_table

Extrapolated burst initial loss values (mm), for QA (see pytuflow.arr.working_data), in the same duration (index) x AEP% (columns) table shape as burst_loss_table, keyed by climate change scenario label (None for the base, no-CC scenario).

additional_tp_responses

Raw ARR Data Hub JSON responses and increments CSV text for each temporal_patterns.additional_tp region fetched, keyed by (title-cased) region name - populated by _tp_set_for_config(), for optional working-data output (see pytuflow.arr.working_data).