# svir package

## Subpackages

- svir.calculations package
  - Submodules
  - svir.calculations.aggregate_loss_by_zone module
  - svir.calculations.calculate_utils module
  - svir.calculations.process_layer module
  - svir.calculations.transformation_algs module
  - Module contents
- svir.dialogs package
  - Submodules
  - svir.dialogs.download_layer_dialog module
  - svir.dialogs.drive_oq_engine_server_dialog module
  - svir.dialogs.load_dmg_by_asset_as_layer_dialog module
  - svir.dialogs.load_gmf_data_as_layer_dialog module
  - svir.dialogs.load_hcurves_as_layer_dialog module
  - svir.dialogs.load_hmaps_as_layer_dialog module
  - svir.dialogs.load_losses_by_asset_as_layer_dialog module
  - svir.dialogs.load_output_as_layer_dialog module
  - svir.dialogs.load_ruptures_as_layer_dialog module
  - svir.dialogs.load_uhs_as_layer_dialog module
  - svir.dialogs.projects_manager_dialog module
  - svir.dialogs.recovery_modeling_dialog module
  - svir.dialogs.recovery_settings_dialog module
  - svir.dialogs.select_sv_variables_dialog module
  - svir.dialogs.settings_dialog module
  - svir.dialogs.show_console_dialog module
  - svir.dialogs.show_full_report_dialog module
  - svir.dialogs.show_params_dialog module
  - svir.dialogs.transformation_dialog module
  - svir.dialogs.upload_dialog module
  - svir.dialogs.upload_settings_dialog module
  - svir.dialogs.viewer_dock module
  - svir.dialogs.weight_data_dialog module
  - Module contents
- svir.metadata package
  - Submodules
  - svir.metadata.iso_19115_template module
  - svir.metadata.metadata_utilities module
  - Module contents
- svir.recovery_modeling package
  - Submodules
  - svir.recovery_modeling.building module
  - svir.recovery_modeling.recovery_modeling module
  - Module contents
- svir.test package
  - Subpackages
    - svir.test.integration package
      - Submodules
      - svir.test.integration.test_drive_oq_engine module
      - Module contents
    - svir.test.unit package
      - Submodules
      - svir.test.unit.test_calculate_indices module
      - svir.test.unit.test_init module
      - svir.test.unit.test_irmt module
      - svir.test.unit.test_load_oq_engine_output_as_layer module
      - svir.test.unit.test_loss_aggreagation module
      - svir.test.unit.test_metadata_utilities module
      - svir.test.unit.test_process_layer module
      - svir.test.unit.test_qgis_environment module
      - svir.test.unit.test_recovery_modeling module
      - svir.test.unit.test_transformations module
      - svir.test.unit.test_translations module
      - Module contents
  - Submodules
  - svir.test.qgis_interface module
  - svir.test.qgis_legend_interface module
  - svir.test.utilities module
  - Module contents
- svir.thread_worker package
  - Submodules
  - svir.thread_worker.abstract_worker module
  - svir.thread_worker.download_platform_data_worker module
  - svir.thread_worker.download_platform_project_worker module
  - svir.thread_worker.upload_worker module
  - Module contents
- svir.ui package
  - Submodules
  - svir.ui.list_multiselect_widget module
  - svir.ui.tool_button_with_help_link module
  - Module contents
- svir.utilities package
  - Submodules
  - svir.utilities.defaults module
  - svir.utilities.import_sv_data module
  - svir.utilities.shared module
  - svir.utilities.sldadapter module
  - svir.utilities.utils module
  - Module contents

## Submodules

## svir.irmt module

class `svir.irmt.``Irmt`(iface)

  Bases: `object`

  `add_menu_item`(action_name, icon_path, label, corresponding_method, enable=False, add_to_layer_actions=False, layers_type=0, set_checkable=False, set_checked=False, submenu=None, add_to_toolbar=False)

    Add an item to the OpenQuake IRMT menu and a corresponding toolbar icon

    Parameters: | icon_path – path of the icon associated to the action label – name of the action, visible to the user corresponding_method – method called when the action is triggered

  `aggregate`()
  `clear_layer_suppl_info`(layer_id)
  `current_layer_changed`(layer=None)
  `download_layer`()

    Open dialog to select one of the integrated risk projects available on the OQ-Platform and download it as a qgis project

  `drive_oq_engine_server`(show=True, hostname=None)
  `experimental_enabled`()
  `get_ipt_checksum`()
  `get_ipt_dir`()
  static `get_menu`(parent, title)
  `import_sv_variables`()

    Open a modal dialog to select socioeconomic variables to download from the openquake platform

  `initGui`()
  `initProcessing`()
  `instantiate_taxonomy_dlg`()
  `ipt`()
  `is_iri_computable`(proj_def)

    Check if is it possible to compute the integrated risk index, depending on the current project definition structure.

  `is_iri_renderable`(proj_def)

    Check if is it possible to render the integrated risk index, depending on the current project definition structure.

  `is_ri_computable`(proj_def)

    Check if is it possible to compute the risk index, depending on the current project definition structure.

  `is_ri_renderable`(proj_def)

    Check if is it possible to render the risk index, depending on the current project definition structure.

  `is_svi_computable`(proj_def)

    Check if is it possible to compute the social vulnerability index, depending on the current project definition structure.

  `is_svi_renderable`(proj_def)

    Check if is it possible to render the social vulnerability index, depending on the current project definition structure.

  `layers_added`()
  `layers_removed`(layer_ids)
  `notify_added_attrs_and_discarded_feats`(added_attrs_ids, discarded_feats)

    Notify through the message bar that new attributes have been added to the layer and specify if missing or invalid values were found.

  `on_drive_oq_engine_server_btn_clicked`()
  `on_iface_initialization_completed`()
  `on_same_fs`(checksum_file_path, local_checksum)
  `on_viewer_dock_visibility_changed`(visible)
  `project_definitions_manager`()

    Open a dialog to manage one or multiple project definitions for the selected layer.

  `recovery_modeling`()
  `recovery_settings`()
  `redraw_ir_layer`(data)

    If the user has explicitly selected a field to use for styling, use it, otherwise attempt to show the IRI, or the SVI, or the RI

  `reset_drive_oq_engine_server_dlg`(hostname=None)
  `show_manual`()
  `show_settings`()

    Open a dialog to specify the connection settings used to interact with the OpenQuake Platform

  `taxonomy`()
  `taxtweb`()
  `toggle_dock_visibility`()

    Show or hide the dock widget.

  `transform_attributes`()

    A modal dialog is displayed to the user, enabling to transform one or more attributes of the active layer, using one of the available algorithms and variants

  `unload`()

    Remove all plugin’s actions and corresponding buttons and connects

  `update_actions_status`()

    Enable plugin’s actions depending on the current status of the workflow

  `upload`()

    Open a dialog to upload the current project to the OpenQuake Platform

  `weight_data`()

    Open a modal dialog to select weights in a d3.js visualization and to run integrated risk calculations.

## svir.resources_rc module

`svir.resources_rc.``qCleanupResources`()

`svir.resources_rc.``qInitResources`()

## Module contents

`svir.``classFactory`(iface)