oasislmf.lookup.base

Classes

AbstractBasicKeyLookup	Basic abstract class for KeyLookup
MultiprocLookupMixin	Simple mixin class for multiprocessing
OasisBaseLookup	Abstract class that help with the implementation of the KeyServerInterface.

Module Contents

class oasislmf.lookup.base.AbstractBasicKeyLookup(config, config_dir=None, user_data_dir=None, output_dir=None)

Basic abstract class for KeyLookup

interface_version = '1'

config

config_dir = '.'

user_data_dir = None

output_dir = None

abstract process_locations(locations)

Process location rows - passed in as a pandas dataframe. Results can be list, tuple, generator or a pandas dataframe.

class oasislmf.lookup.base.MultiprocLookupMixin

Simple mixin class for multiprocessing

implement the process_locations_multiproc by transforming the result of process_locations into a pandas DataFrame

process_locations_multiproc(loc_df_part)

class oasislmf.lookup.base.OasisBaseLookup(config=None, config_json=None, config_fp=None, config_dir=None, user_data_dir=None, output_dir=None)

Bases: AbstractBasicKeyLookup, MultiprocLookupMixin

Abstract class that help with the implementation of the KeyServerInterface. require lookup method to be implemented. Lookup will be call to create a key for each peril id and coverage type

multiproc_enabled = True

peril_ids

peril_id_col

coverage_types

coverage_type_col

property config

abstract lookup(loc, peril_id, coverage_type, **kwargs)

Lookup for an individual location item, which could be a dict or a Pandas series object.

process_locations(locs)

Bulk vulnerability lookup for a list, tuple, generator, pandas data frame or dict of location items, which can be dicts or Pandas series objects or any object which has as a dict-like interface.

Generates results using yield.

Yields:

dict – the lookup result for each (location, peril_id, coverage_type) combination