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
Oasis LMF Documentation

Contents:

  • Installation
  • Building and Running Models
  • Options for the JSON Configuration File
    • verbose
    • 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
    • ktools_legacy_stream
    • fmpy
    • ktools_alloc_rule_il
    • ktools_alloc_rule_ri
    • summarypy
    • check_missing_inputs
    • ktools_num_processes
    • ktools_event_shuffle
    • ktools_alloc_rule_gul
    • ktools_num_gul_per_lb
    • ktools_num_fm_per_lb
    • ktools_disable_guard
    • ktools_fifo_relative
    • modelpy
    • gulpy
    • gulpy_random_generator
    • gulmc
    • gulmc_random_generator
    • gulmc_effective_damageability
    • gulmc_vuln_cache_size
    • fmpy_low_memory
    • fmpy_sort_output
    • model_custom_gulcalc
    • model_py_server
    • peril_filter
    • join_summary_info
    • eltpy
    • pltpy
    • aalpy
    • lecpy
    • model_custom_gulcalc_log_start
    • model_custom_gulcalc_log_finish
    • base_df_engine
    • model_df_engine
    • exposure_df_engine
    • dynamic_footprint
    • 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
    • pre_loss_class_name
    • pre_loss_setting_json
    • keys_data_csv
    • keys_errors_csv
    • 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
    • lookup_multiprocessing
    • 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
    • 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
    • supported_oed_coverage_types
    • model_perils_covered
    • server_login_json
    • server_url
    • server_version
    • model_id
    • portfolio_id
    • analysis_id
    • output_dir
  • API Reference
    • oasislmf
      • oasislmf.cli
        • oasislmf.cli.admin
        • oasislmf.cli.api
        • oasislmf.cli.command
        • oasislmf.cli.config
        • oasislmf.cli.exposure
        • oasislmf.cli.model
        • oasislmf.cli.root
        • oasislmf.cli.test
        • oasislmf.cli.version
      • oasislmf.computation
        • oasislmf.computation.base
        • oasislmf.computation.data
          • oasislmf.computation.data.dummy_model
            • oasislmf.computation.data.dummy_model.generate
        • oasislmf.computation.generate
          • oasislmf.computation.generate.doc
          • oasislmf.computation.generate.files
          • oasislmf.computation.generate.keys
          • oasislmf.computation.generate.losses
        • oasislmf.computation.helper
          • oasislmf.computation.helper.autocomplete
        • oasislmf.computation.hooks
          • oasislmf.computation.hooks.post_analysis
          • oasislmf.computation.hooks.post_file_gen
          • oasislmf.computation.hooks.pre_analysis
          • oasislmf.computation.hooks.pre_loss
        • oasislmf.computation.run
          • oasislmf.computation.run.exposure
          • oasislmf.computation.run.generate_documentation
          • oasislmf.computation.run.generate_files
          • oasislmf.computation.run.generate_losses
          • oasislmf.computation.run.model
          • oasislmf.computation.run.platform
      • oasislmf.execution
        • oasislmf.execution.bash
        • oasislmf.execution.bin
        • oasislmf.execution.complex_items_to_bin
        • oasislmf.execution.complex_items_to_csv
        • oasislmf.execution.conf
        • oasislmf.execution.files
        • oasislmf.execution.load_balancer
        • oasislmf.execution.runner
      • oasislmf.lookup
        • oasislmf.lookup.base
        • oasislmf.lookup.builtin
        • oasislmf.lookup.factory
        • oasislmf.lookup.interface
      • oasislmf.manager
      • oasislmf.platform_api
        • oasislmf.platform_api.client
        • oasislmf.platform_api.session
      • oasislmf.preparation
        • oasislmf.preparation.correlations
        • oasislmf.preparation.dir_inputs
        • oasislmf.preparation.gul_inputs
        • oasislmf.preparation.il_inputs
        • oasislmf.preparation.lookup
        • oasislmf.preparation.reinsurance_layer
        • oasislmf.preparation.summaries
      • oasislmf.pytools
        • oasislmf.pytools.aal
          • oasislmf.pytools.aal.cli
          • oasislmf.pytools.aal.data
          • oasislmf.pytools.aal.manager
        • oasislmf.pytools.cdftocsv
        • oasislmf.pytools.common
          • oasislmf.pytools.common.data
          • oasislmf.pytools.common.event_stream
          • oasislmf.pytools.common.input_files
          • oasislmf.pytools.common.utils
            • oasislmf.pytools.common.utils.nb_heapq
        • oasislmf.pytools.compare_bin
        • oasislmf.pytools.correlationtobin
        • oasislmf.pytools.correlationtocsv
        • oasislmf.pytools.data_layer
          • oasislmf.pytools.data_layer.conversions
            • oasislmf.pytools.data_layer.conversions.correlations
            • oasislmf.pytools.data_layer.conversions.footprint
          • oasislmf.pytools.data_layer.footprint_layer
          • oasislmf.pytools.data_layer.oasis_files
            • oasislmf.pytools.data_layer.oasis_files.correlations
        • oasislmf.pytools.dfcompare
        • oasislmf.pytools.elt
          • oasislmf.pytools.elt.cli
          • oasislmf.pytools.elt.data
          • oasislmf.pytools.elt.manager
        • 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.stream_sparse
        • oasislmf.pytools.footprintconv
        • oasislmf.pytools.getmodel
          • oasislmf.pytools.getmodel.common
          • oasislmf.pytools.getmodel.footprint
          • oasislmf.pytools.getmodel.manager
          • oasislmf.pytools.getmodel.vulnerability
        • oasislmf.pytools.gul
          • oasislmf.pytools.gul.common
          • oasislmf.pytools.gul.core
          • oasislmf.pytools.gul.io
          • oasislmf.pytools.gul.manager
          • oasislmf.pytools.gul.random
          • oasislmf.pytools.gul.utils
        • 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.gulpy
        • oasislmf.pytools.indexconvert
        • oasislmf.pytools.join_summary_info
          • oasislmf.pytools.join_summary_info.cli
          • oasislmf.pytools.join_summary_info.manager
        • oasislmf.pytools.kat
          • oasislmf.pytools.kat.cli
          • oasislmf.pytools.kat.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.modelpy
        • oasislmf.pytools.pla
          • oasislmf.pytools.pla.cli
          • oasislmf.pytools.pla.common
          • oasislmf.pytools.pla.manager
          • oasislmf.pytools.pla.streams
          • oasislmf.pytools.pla.structure
        • oasislmf.pytools.plt
          • oasislmf.pytools.plt.cli
          • oasislmf.pytools.plt.data
          • oasislmf.pytools.plt.manager
        • oasislmf.pytools.summary
          • oasislmf.pytools.summary.cli
          • oasislmf.pytools.summary.manager
        • oasislmf.pytools.utils
      • oasislmf.utils
        • oasislmf.utils.calc_rules
        • oasislmf.utils.compress
        • oasislmf.utils.coverages
        • oasislmf.utils.data
        • oasislmf.utils.defaults
        • oasislmf.utils.diff
        • oasislmf.utils.documentation
          • oasislmf.utils.documentation.jsontomd
            • oasislmf.utils.documentation.jsontomd.base
            • oasislmf.utils.documentation.jsontomd.default
            • oasislmf.utils.documentation.jsontomd.rdls_0__2__0
          • oasislmf.utils.documentation.markdown
        • oasislmf.utils.exceptions
        • oasislmf.utils.fm
        • oasislmf.utils.inputs
        • oasislmf.utils.log
        • oasislmf.utils.oed
        • oasislmf.utils.path
        • oasislmf.utils.peril
        • oasislmf.utils.profiles
        • oasislmf.utils.status
        • oasislmf.utils.version_info
      • oasislmf.validation
        • oasislmf.validation.model_data
Back to top
View this page

oasislmf.computation.run.generate_documentation¶

Classes¶

GenerateDocumentation

Generate Documentation for model from the config file

Module Contents¶

class oasislmf.computation.run.generate_documentation.GenerateDocumentation(**kwargs)[source]¶

Bases: oasislmf.computation.base.ComputationStep

Generate Documentation for model from the config file

step_params = [][source]¶
chained_commands[source]¶
run()[source]¶
Next
oasislmf.computation.run.generate_files
Previous
oasislmf.computation.run.exposure
Copyright © 2025 Oasis LMF
Made with Sphinx and @pradyunsg's Furo
On this page
  • oasislmf.computation.run.generate_documentation
    • Classes
    • Module Contents
      • GenerateDocumentation
        • GenerateDocumentation.step_params
        • GenerateDocumentation.chained_commands
        • GenerateDocumentation.run()