oasislmf.pytools.getmodel.common
================================

.. py:module:: oasislmf.pytools.getmodel.common

.. autoapi-nested-parse::

   This file defines the data types that are loaded from the data files.



Attributes
----------

.. autoapisummary::

   oasislmf.pytools.getmodel.common.fp_format_priorities
   oasislmf.pytools.getmodel.common.footprint_filename
   oasislmf.pytools.getmodel.common.footprint_index_filename
   oasislmf.pytools.getmodel.common.zfootprint_filename
   oasislmf.pytools.getmodel.common.zfootprint_index_filename
   oasislmf.pytools.getmodel.common.csvfootprint_filename
   oasislmf.pytools.getmodel.common.parquetfootprint_filename
   oasislmf.pytools.getmodel.common.parquetfootprint_meta_filename
   oasislmf.pytools.getmodel.common.event_defintion_filename
   oasislmf.pytools.getmodel.common.hazard_case_filename
   oasislmf.pytools.getmodel.common.FootprintHeader
   oasislmf.pytools.getmodel.common.Event
   oasislmf.pytools.getmodel.common.EventCSV
   oasislmf.pytools.getmodel.common.EventIndexBin
   oasislmf.pytools.getmodel.common.EventIndexBinZ
   oasislmf.pytools.getmodel.common.Index_type
   oasislmf.pytools.getmodel.common.Vulnerability
   oasislmf.pytools.getmodel.common.Item
   oasislmf.pytools.getmodel.common.Event_defintion
   oasislmf.pytools.getmodel.common.Hazard_case
   oasislmf.pytools.getmodel.common.Keys


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

.. py:data:: fp_format_priorities
   :value: ['parquet', 'binZ', 'bin', 'csv', 'parquet_dynamic']


.. py:data:: footprint_filename
   :value: 'footprint.bin'


.. py:data:: footprint_index_filename
   :value: 'footprint.idx'


.. py:data:: zfootprint_filename
   :value: 'footprint.bin.z'


.. py:data:: zfootprint_index_filename
   :value: 'footprint.idx.z'


.. py:data:: csvfootprint_filename
   :value: 'footprint.csv'


.. py:data:: parquetfootprint_filename
   :value: 'footprint.parquet'


.. py:data:: parquetfootprint_meta_filename
   :value: 'footprint_parquet_meta.json'


.. py:data:: event_defintion_filename
   :value: 'event_definition.parquet'


.. py:data:: hazard_case_filename
   :value: 'hazard_case.parquet'


.. py:data:: FootprintHeader

.. py:data:: Event

.. py:data:: EventCSV

.. py:data:: EventIndexBin

.. py:data:: EventIndexBinZ

.. py:data:: Index_type

.. py:data:: Vulnerability

.. py:data:: Item

.. py:data:: Event_defintion

.. py:data:: Hazard_case

.. py:data:: Keys