oasislmf.utils.defaults
=======================

.. py:module:: oasislmf.utils.defaults


Attributes
----------

.. autoapisummary::

   oasislmf.utils.defaults.API_EXAMPLE_AUTH
   oasislmf.utils.defaults.DEFAULT_RTREE_INDEX_PROPS
   oasislmf.utils.defaults.SOURCE_IDX
   oasislmf.utils.defaults.SUMMARY_MAPPING
   oasislmf.utils.defaults.SUMMARY_OUTPUT
   oasislmf.utils.defaults.STATIC_DATA_FP
   oasislmf.utils.defaults.WRITE_CHUNKSIZE
   oasislmf.utils.defaults.DAMAGE_GROUP_ID_COLS
   oasislmf.utils.defaults.HAZARD_GROUP_ID_COLS
   oasislmf.utils.defaults.CORRELATION_GROUP_ID
   oasislmf.utils.defaults.OASIS_FILES_PREFIXES
   oasislmf.utils.defaults.KTOOLS_NUM_PROCESSES
   oasislmf.utils.defaults.KTOOLS_FIFO_RELATIVE
   oasislmf.utils.defaults.KTOOLS_DISABLE_ERR_GUARD
   oasislmf.utils.defaults.KTOOLS_GUL_LEGACY_STREAM
   oasislmf.utils.defaults.KTOOLS_ALLOC_GUL_MAX
   oasislmf.utils.defaults.KTOOLS_ALLOC_FM_MAX
   oasislmf.utils.defaults.KTOOLS_ALLOC_IL_DEFAULT
   oasislmf.utils.defaults.KTOOLS_ALLOC_RI_DEFAULT
   oasislmf.utils.defaults.KTOOLS_DEBUG


Functions
---------

.. autoapisummary::

   oasislmf.utils.defaults.store_exposure_fp
   oasislmf.utils.defaults.find_exposure_fp
   oasislmf.utils.defaults.get_default_accounts_profile
   oasislmf.utils.defaults.get_default_exposure_profile
   oasislmf.utils.defaults.get_default_fm_profile_field_values
   oasislmf.utils.defaults.get_default_step_policies_profile
   oasislmf.utils.defaults.get_config_profile
   oasislmf.utils.defaults.get_default_unified_profile
   oasislmf.utils.defaults.get_default_fm_aggregation_profile
   oasislmf.utils.defaults.assign_defaults_to_il_inputs
   oasislmf.utils.defaults.get_default_deterministic_analysis_settings


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

.. py:data:: API_EXAMPLE_AUTH

.. py:data:: DEFAULT_RTREE_INDEX_PROPS

.. py:data:: SOURCE_IDX

.. py:data:: SUMMARY_MAPPING

.. py:data:: SUMMARY_OUTPUT

.. py:data:: STATIC_DATA_FP

.. py:function:: store_exposure_fp(fp, exposure_type)

   Preserve original exposure file extention if its in a pandas supported
   compressed format

   compression : {‘infer’, ‘gzip’, ‘bz2’, ‘zip’, ‘xz’, None}, default ‘infer’
                 For on-the-fly decompression of on-disk data. If ‘infer’ and
                 filepath_or_buffer is path-like, then detect compression from
                 the following extensions: ‘.gz’, ‘.bz2’, ‘.zip’, or ‘.xz’
                 (otherwise no decompression).

                 If using ‘zip’, the ZIP file must contain only one data file
                 to be read in. Set to None for no decompression.

               New in version 0.18.1: support for ‘zip’ and ‘xz’ compression.


.. py:function:: find_exposure_fp(input_dir, exposure_type, required=True)

   Find an OED exposure file stored in the oasis inputs dir
   while preserving the compressed ext


.. py:function:: get_default_accounts_profile(path=False)

.. py:function:: get_default_exposure_profile(path=False)

.. py:function:: get_default_fm_profile_field_values(path=False)

.. py:function:: get_default_step_policies_profile(path=False)

.. py:function:: get_config_profile(path=False)

.. py:function:: get_default_unified_profile(path=False)

.. py:function:: get_default_fm_aggregation_profile(path=False)

.. py:function:: assign_defaults_to_il_inputs(df)

   Assign default values to IL inputs.

   :param df: IL input items dataframe
   :type df: pandas.DataFrame

   :return: IL input items dataframe
   :rtype: pandas.DataFrame


.. py:data:: WRITE_CHUNKSIZE

.. py:data:: DAMAGE_GROUP_ID_COLS
   :value: ['PortNumber', 'AccNumber', 'LocNumber']


.. py:data:: HAZARD_GROUP_ID_COLS
   :value: ['PortNumber', 'AccNumber', 'LocNumber']


.. py:data:: CORRELATION_GROUP_ID
   :value: ['CorrelationGroup']


.. py:data:: OASIS_FILES_PREFIXES

.. py:function:: get_default_deterministic_analysis_settings(path=False)

.. py:data:: KTOOLS_NUM_PROCESSES

.. py:data:: KTOOLS_FIFO_RELATIVE
   :value: False


.. py:data:: KTOOLS_DISABLE_ERR_GUARD
   :value: False


.. py:data:: KTOOLS_GUL_LEGACY_STREAM
   :value: False


.. py:data:: KTOOLS_ALLOC_GUL_MAX
   :value: 3


.. py:data:: KTOOLS_ALLOC_FM_MAX
   :value: 3


.. py:data:: KTOOLS_ALLOC_IL_DEFAULT
   :value: 2


.. py:data:: KTOOLS_ALLOC_RI_DEFAULT
   :value: 3


.. py:data:: KTOOLS_DEBUG
   :value: False