Reference

Information-oriented material: dry, look-it-up facts. Most of this section is generated from the source, so it stays in step with the code.

Configuration & CLI

• Options for the JSON Configuration File
• Environment Variables

Model data & package

File formats for model and Oasis input/output data, and the oasislmf Python package reference:

• OasisLMF Package
• Oasis Model Data Formats
• Oasis File Formats

Python API

The API reference is generated directly from the source docstrings with sphinx-autoapi (AST-based, so it never imports the package).

Note

The API reference is scoped per-subsystem rather than covering the whole package, so each subsystem sits beside the explanation pages that describe it and the build stays fast. Currently included: the Financial Module (oasislmf.pytools.fm), the ground-up Monte-Carlo engine (oasislmf.pytools.gulmc), the shared stream/data layer (oasislmf.pytools.common), the output modules (elt, lec, plt, aal, summary, pla) and the keys/lookup framework (oasislmf.lookup). Coverage widens as more subsystems are documented.

• oasislmf.pytools.fm
  • Submodules
  • Attributes
  • Package Contents
• oasislmf.pytools.gulmc
  • Submodules
  • Attributes
  • Package Contents
• oasislmf.pytools.common
  • Submodules
• oasislmf.pytools.elt
  • Submodules
  • Attributes
  • Package Contents
• oasislmf.pytools.lec
  • Submodules
  • Attributes
  • Package Contents
• oasislmf.pytools.plt
  • Submodules
  • Attributes
  • Package Contents
• oasislmf.pytools.aal
  • Submodules
  • Attributes
  • Package Contents
• oasislmf.pytools.summary
  • Submodules
  • Attributes
  • Package Contents
• oasislmf.pytools.pla
  • Submodules
  • Attributes
  • Package Contents
• oasislmf.lookup
  • Submodules

Outputs & results

The Oasis loss outputs (standard and ORD result tables), their formats and file-naming conventions.

• Outputs & results

Calculation kernel

Component, stream-format, converter, validation and calc-rule reference for the Oasis calculation kernel, migrated from ktools and being updated to the pytools implementation.

• Calculation kernel