Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
Oasis LMF Documentation
Light Logo Dark Logo
Oasis LMF Documentation

Tutorials

  • Tutorials
    • Run your first analysis
    • Explore Oasis model data
    • Analyse ORD results: from an ELT to an EP curve

How-to guides

  • Installation
  • Building and Running Models
  • Logging Configuration
  • MDK - Model Development Kit
  • API Client CLI
  • Compute ground-up losses with gulmc
  • The MDK Built-in Lookup Framework
  • Oasis Evaluation

Reference

  • Reference
    • Options for the JSON Configuration File
      • verbose
      • log_level
      • log_format
      • config
      • oasis_files_dir
      • exposure_pre_analysis_module
      • post_analysis_module
      • pre_loss_module
      • post_file_gen_module
      • check_oed
      • analysis_settings_json
      • model_storage_json
      • model_settings_json
      • user_data_dir
      • model_data_dir
      • copy_model_data
      • model_run_dir
      • model_package_dir
      • kernel_alloc_rule_il
      • kernel_alloc_rule_ri
      • check_missing_inputs
      • intermediary_csv
      • kernel_num_processes
      • kernel_event_shuffle
      • kernel_alloc_rule_gul
      • kernel_num_gul_per_lb
      • kernel_num_fm_per_lb
      • kernel_disable_guard
      • kernel_fifo_relative
      • gulmc
      • gul_random_generator
      • gulmc_effective_damageability
      • gulmc_vuln_cache_size
      • fmpy_low_memory
      • fmpy_sort_output
      • summarypy_low_memory
      • model_custom_gulcalc
      • model_py_server
      • peril_filter
      • join_summary_info
      • model_custom_gulcalc_log_start
      • model_custom_gulcalc_log_finish
      • base_df_engine
      • model_df_engine
      • exposure_df_engine
      • dynamic_footprint
      • socket_server_ip
      • socket_server_port
      • resource_monitor_interval
      • post_file_gen_class_name
      • post_file_gen_setting_json
      • oed_schema_info
      • oed_location_csv
      • oed_accounts_csv
      • oed_info_csv
      • oed_scope_csv
      • location
      • portfolio
      • account
      • oed_backend_dtype
      • pre_loss_class_name
      • pre_loss_setting_json
      • keys_data_path
      • keys_errors_path
      • profile_loc_json
      • profile_acc_json
      • profile_fm_agg_json
      • currency_conversion_json
      • reporting_currency
      • disable_summarise_exposure
      • damage_group_id_cols
      • hazard_group_id_cols
      • do_disaggregation
      • keys_format
      • lookup_config_json
      • lookup_data_dir
      • lookup_module_path
      • lookup_complex_config_json
      • lookup_num_processes
      • lookup_num_chunks
      • model_version_csv
      • lookup_multiprocessing
      • disable_oed_version_update
      • exposure_pre_analysis_class_name
      • exposure_pre_analysis_setting_json
      • post_analysis_class_name
      • lookup_config
      • lookup_complex_config
      • write_ri_tree
      • write_chunksize
      • oasis_files_prefixes
      • src_dir
      • run_dir
      • output_file
      • loss_factor
      • output_level
      • extra_summary_cols
      • stream_type
      • net_ri
      • include_loss_factor
      • print_summary
      • portfolio_complexity
      • supported_oed_coverage_types
      • model_perils_covered
      • server_login_json
      • server_url
      • server_version
      • auth_type
      • oidc_token_url
      • oidc_scope
      • model_id
      • portfolio_id
      • analysis_id
      • lookup_chunks
      • output_dir
      • analysis_chunks
    • Environment Variables
    • OasisLMF Package
    • Oasis Model Data Formats
    • Oasis File Formats
    • oasislmf.pytools.fm
      • oasislmf.pytools.fm.back_allocation
      • oasislmf.pytools.fm.cli
      • oasislmf.pytools.fm.common
      • oasislmf.pytools.fm.compare
      • oasislmf.pytools.fm.compute_sparse
      • oasislmf.pytools.fm.financial_structure
      • oasislmf.pytools.fm.manager
      • oasislmf.pytools.fm.policy
      • oasislmf.pytools.fm.policy_extras
      • oasislmf.pytools.fm.portfolio_complexity
      • oasislmf.pytools.fm.stream_sparse
    • oasislmf.pytools.gulmc
      • oasislmf.pytools.gulmc.aggregate
      • oasislmf.pytools.gulmc.cli
      • oasislmf.pytools.gulmc.common
      • oasislmf.pytools.gulmc.items
      • oasislmf.pytools.gulmc.manager
      • oasislmf.pytools.gulmc.structure
    • oasislmf.pytools.elt
      • oasislmf.pytools.elt.cli
      • oasislmf.pytools.elt.data
      • oasislmf.pytools.elt.manager
    • oasislmf.pytools.lec
      • oasislmf.pytools.lec.aggreports
        • oasislmf.pytools.lec.aggreports.aggreports
        • oasislmf.pytools.lec.aggreports.outputs
          • oasislmf.pytools.lec.aggreports.outputs.full_uncertainty
          • oasislmf.pytools.lec.aggreports.outputs.mean_damage_ratio
          • oasislmf.pytools.lec.aggreports.outputs.sample_mean
          • oasislmf.pytools.lec.aggreports.outputs.wheatsheaf
          • oasislmf.pytools.lec.aggreports.outputs.wheatsheaf_mean
        • oasislmf.pytools.lec.aggreports.write_tables
      • oasislmf.pytools.lec.cli
      • oasislmf.pytools.lec.data
      • oasislmf.pytools.lec.manager
      • oasislmf.pytools.lec.utils
    • oasislmf.pytools.plt
      • oasislmf.pytools.plt.cli
      • oasislmf.pytools.plt.data
      • oasislmf.pytools.plt.manager
    • oasislmf.pytools.aal
      • oasislmf.pytools.aal.cli
      • oasislmf.pytools.aal.data
      • oasislmf.pytools.aal.manager
    • oasislmf.pytools.summary
      • oasislmf.pytools.summary.cli
      • oasislmf.pytools.summary.manager
    • oasislmf.pytools.pla
      • oasislmf.pytools.pla.cli
      • oasislmf.pytools.pla.common
      • oasislmf.pytools.pla.manager
      • oasislmf.pytools.pla.streams
      • oasislmf.pytools.pla.structure
    • oasislmf.lookup
      • oasislmf.lookup.base
      • oasislmf.lookup.builtin
      • oasislmf.lookup.factory
      • oasislmf.lookup.interface
    • Outputs & results
      • Results
    • Calculation kernel
      • Table of Contents
      • 1. Introduction
      • 2. Data Streaming Framework Overview
      • 4. Reference Model Overview
      • Core components
      • 3. Specification
      • Appendix B: FM Profiles
      • Output components
      • ORD output components
      • Data conversion components
      • Stream conversion components
      • Validation
      • Appendix C: Multi-peril model support
      • Appendix A: Random numbers
      • Workflows

Explanation

  • Explanation
    • Financial Module
    • Financial Module — architecture
    • Modelling methodology
    • Sampling Methodology
    • Correlation
    • Disaggregation
    • Coverage dependency (gulmc)
    • Vulnerability Adjustments
    • Absolute Damage
    • Post Loss Amplification
    • Pre Analysis Adjustments
    • Currency Conversion
    • Oasis Models
    • Keys Service
    • Geocoding
Back to top
View this page

Table of Contents¶

1. Introduction¶

2. Data streaming architecture overview¶

3. Specification¶

4. Reference model¶

4.1 Core components¶

4.2 Output components¶

4.3 ORD output components¶

4.4 Data conversion components¶

4.5 Stream conversion components¶

4.6 Validation components¶

5. Financial Module¶

6. Workflows¶

Appendix A Random numbers¶

Appendix B FM profiles¶

Appendix C Multi-peril model support¶

Next
1. Introduction
Previous
Calculation kernel
Copyright © 2026 Oasis LMF
Made with Sphinx and @pradyunsg's Furo
On this page
  • Table of Contents
    • 1. Introduction
    • 2. Data streaming architecture overview
    • 3. Specification
    • 4. Reference model
    • 4.1 Core components
    • 4.2 Output components
    • 4.3 ORD output components
    • 4.4 Data conversion components
    • 4.5 Stream conversion components
    • 4.6 Validation components
    • 5. Financial Module
    • 6. Workflows
    • Appendix A Random numbers
    • Appendix B FM profiles
    • Appendix C Multi-peril model support