oasislmf 2.5.5 — Oasis Loss Modelling Framework

This repository provides a Python toolkit (the Model Development Kit) for building, running and testing Oasis LMF models end-to-end. It includes an API client, a class framework for working with models and exposures, a keys/lookup factory, and a command line interface (run oasislmf --help).

The documentation is organised using the Diátaxis framework — Tutorials, How-to guides, Reference and Explanation — so each page has one clear job. See DOCS_STRATEGY.md in the repository root for the documentation strategy this structure is part of.

Start where you fit

🧭 New here?

Learn by doing. Run a first analysis end-to-end. Tutorials.

Tutorials
🛠️ Model developer

Build, run and test models with the MDK. How-to guides.

Building and Running Models
📖 Need a fact?

CLI options, environment variables and the Python API, generated from source. Reference.

Reference
💡 Want the why?

How the Financial Module and the rest of the framework work, and why. Explanation.

Explanation

Indices and tables