Skip to content

jonathanbethel/OasisLMF

 
 

Repository files navigation

Oasis LMF logo

PyPI version Build

OasisLMF

The oasislmf Python package provides a Python toolkit for building, running and testing Oasis models end-to-end, including performing individual steps in this process. It includes:

  • a Python class framework for working with Oasis models and model resources as Python objects (the oasislmf.models subpackage)
  • a Python class framework for managing model exposures and resources, and also for generating Oasis files from these (the oasislmf.exposures subpackage)
  • a Python factory class for instantiating keys lookups for models, and generating and saving keys outputs from these lookups (the oasislmf.keys subpackage)
  • a command line interface for running models end-to-end, including performing individual steps:
    • generating keys from model keys lookups, and writing them as files: oasislmf model generate-keys
    • generating Oasis files (GUL only at present, FM to be added later) from source exposure files, canonical profiles, exposure validation and transformation files, and keys data files: oasislmf model generate-oasis-files
    • generating losses from Oasis files and analysis settings: oasislmf model generate-losses
    • running a model end-to-end: oasislmf model run

Installation

Dependencies