:py:mod:`hazimp.templates.flood`
================================

.. py:module:: hazimp.templates.flood


Module Contents
---------------


Functions
~~~~~~~~~

.. autoapisummary::

   hazimp.templates.flood._flood_impact_reader
   hazimp.templates.flood._flood_fabric_v2_reader
   hazimp.templates.flood._flood_contents_v2_reader



Attributes
~~~~~~~~~~

.. autoapisummary::

   hazimp.templates.flood.LOGGER
   hazimp.templates.flood.CONT_ACTIONS
   hazimp.templates.flood.SAVE_CONT
   hazimp.templates.flood.SAVEAGG_CONT
   hazimp.templates.flood.NO_ACTION_CONT
   hazimp.templates.flood.EXPOSE_CONT
   hazimp.templates.flood.CONT_ACTION_COL
   hazimp.templates.flood.CONT_INSURANCE_COL
   hazimp.templates.flood.CONT_TEMP
   hazimp.templates.flood.INSURE_PROB
   hazimp.templates.flood.INSURED
   hazimp.templates.flood.UNINSURED
   hazimp.templates.flood.CONT_MAP
   hazimp.templates.flood.INSURE_MAP


.. py:data:: LOGGER
   

   

.. py:data:: CONT_ACTIONS
   :annotation: = contents_actions

   

.. py:data:: SAVE_CONT
   :annotation: = save

   

.. py:data:: SAVEAGG_CONT
   :annotation: = save_agg

   

.. py:data:: NO_ACTION_CONT
   :annotation: = no_action

   

.. py:data:: EXPOSE_CONT
   :annotation: = expose

   

.. py:data:: CONT_ACTION_COL
   :annotation: = contents_action

   

.. py:data:: CONT_INSURANCE_COL
   :annotation: = insurance_regime

   

.. py:data:: CONT_TEMP
   :annotation: = regime_action

   

.. py:data:: INSURE_PROB
   :annotation: = insurance_probability

   

.. py:data:: INSURED
   :annotation: = insured

   

.. py:data:: UNINSURED
   :annotation: = uninsured

   

.. py:data:: CONT_MAP
   

   

.. py:data:: INSURE_MAP
   

   

.. py:function:: _flood_impact_reader(config: dict) -> list

   Build a job list from a flood impact configuration file. This template
   assumes floor height is included in the exposure attributes, rather than
   assuming a fixed floor height for all buildings.

   :param config: a dict of jobs describing the pipeline
   :return: a list of job objects representing the pipeline



.. py:function:: _flood_fabric_v2_reader(config: dict) -> list

   This function does two things::

      * From a flood fabric template v2 configuration dictionary
      build the job list.
      * Set up the attributes of the jobs and calc's specifically
      for a flood study.

   :param config_list: A list describing the simulation.
   :returns: A list of jobs to process over.



.. py:function:: _flood_contents_v2_reader(config: dict) -> list

   This function does two things::

      * From a flood contents template v2 configuration dictionary
      build the job list.
      * Set up the attributes of the jobs and calc's specifically
      for a flood study.

   :param config_list: A list describing the simulation.
   :returns: A list of jobs to process over.