physrisk.api

Subpackages

• physrisk.api.v1
  • Submodules
  • physrisk.api.v1.common
    • before_validator()
    • serialize_array()
    • Asset
      • Asset.asset_class
      • Asset.latitude
      • Asset.longitude
      • Asset.wkt
      • Asset.buffer
      • Asset.type
      • Asset.location
      • Asset.occupancy_code
      • Asset.number_of_storeys
      • Asset.basement
      • Asset.construction_code
      • Asset.first_floor_height
      • Asset.capacity
      • Asset.validate_occupancy_code()
      • Asset.model_config
    • Assets
      • Assets.items
      • Assets.model_config
    • BaseHazardRequest
      • BaseHazardRequest.group_ids
      • BaseHazardRequest.model_config
    • Country
      • Country.country
      • Country.continent
      • Country.country_iso_a3
      • Country.model_config
    • Countries
      • Countries.items
      • Countries.model_config
    • IntensityCurve
      • IntensityCurve.intensities
      • IntensityCurve.return_periods
      • IntensityCurve.index_values
      • IntensityCurve.index_name
      • IntensityCurve.model_config
    • ExceedanceCurve
      • ExceedanceCurve.model_config
      • ExceedanceCurve.values
      • ExceedanceCurve.exceed_probabilities
    • Distribution
      • Distribution.model_config
      • Distribution.bin_edges
      • Distribution.probabilities
    • HazardEventDistrib
      • HazardEventDistrib.model_config
      • HazardEventDistrib.intensity_bin_edges
      • HazardEventDistrib.probabilities
      • HazardEventDistrib.path
    • VulnerabilityCurve
      • VulnerabilityCurve.model_config
      • VulnerabilityCurve.asset_type
      • VulnerabilityCurve.location
      • VulnerabilityCurve.event_type
      • VulnerabilityCurve.impact_type
      • VulnerabilityCurve.intensity
      • VulnerabilityCurve.intensity_units
      • VulnerabilityCurve.impact_mean
      • VulnerabilityCurve.impact_std
    • VulnerabilityCurves
      • VulnerabilityCurves.items
      • VulnerabilityCurves.model_config
    • VulnerabilityDistrib
      • VulnerabilityDistrib.model_config
      • VulnerabilityDistrib.intensity_bin_edges
      • VulnerabilityDistrib.impact_bin_edges
      • VulnerabilityDistrib.prob_matrix
  • physrisk.api.v1.example_portfolios
    • ExamplePortfoliosRequest
      • ExamplePortfoliosRequest.model_config
    • ExamplePortfoliosResponse
      • ExamplePortfoliosResponse.portfolios
      • ExamplePortfoliosResponse.model_config
  • physrisk.api.v1.exposure_req_resp
    • AssetExposureRequest
      • AssetExposureRequest.assets
      • AssetExposureRequest.calc_settings
      • AssetExposureRequest.scenario
      • AssetExposureRequest.year
      • AssetExposureRequest.provider_max_requests
      • AssetExposureRequest.model_config
    • Exposure
      • Exposure.category
      • Exposure.value
      • Exposure.path
      • Exposure.model_config
    • AssetExposure
      • AssetExposure.asset_id
      • AssetExposure.exposures
      • AssetExposure.model_config
    • AssetExposureResponse
      • AssetExposureResponse.items
      • AssetExposureResponse.model_config
  • physrisk.api.v1.hazard_data
    • Colormap
      • Colormap.min_index
      • Colormap.min_value
      • Colormap.max_index
      • Colormap.max_value
      • Colormap.name
      • Colormap.nodata_index
      • Colormap.units
      • Colormap.model_config
    • MapInfo
      • MapInfo.colormap
      • MapInfo.bounds
      • MapInfo.bbox
      • MapInfo.index_values
      • MapInfo.path
      • MapInfo.source
      • MapInfo.model_config
    • Period
      • Period.year
      • Period.map_id
      • Period.model_config
    • Scenario
      • Scenario.id
      • Scenario.years
      • Scenario.model_config
    • expanded()
    • HazardResource
      • HazardResource.hazard_type
      • HazardResource.group_id
      • HazardResource.path
      • HazardResource.indicator_id
      • HazardResource.indicator_model_id
      • HazardResource.indicator_model_gcm
      • HazardResource.params
      • HazardResource.display_name
      • HazardResource.display_groups
      • HazardResource.description
      • HazardResource.map
      • HazardResource.scenarios
      • HazardResource.store_netcdf_coords
      • HazardResource.units
      • HazardResource.expand()
      • HazardResource.key()
      • HazardResource.model_config
    • expand()
    • expand_resource()
    • InventorySource
      • InventorySource.EMBEDDED
      • InventorySource.HAZARD
      • InventorySource.HAZARD_TEST
    • HazardAvailabilityRequest
      • HazardAvailabilityRequest.types
      • HazardAvailabilityRequest.sources
      • HazardAvailabilityRequest.model_config
    • HazardAvailabilityResponse
      • HazardAvailabilityResponse.models
      • HazardAvailabilityResponse.colormaps
      • HazardAvailabilityResponse.model_config
    • HazardDescriptionRequest
      • HazardDescriptionRequest.paths
      • HazardDescriptionRequest.model_config
    • HazardDescriptionResponse
      • HazardDescriptionResponse.descriptions
      • HazardDescriptionResponse.model_config
    • StaticInformationResponse
      • StaticInformationResponse.scenario_descriptions
      • StaticInformationResponse.oed_occupancy_codes
      • StaticInformationResponse.model_config
    • HazardDataRequestItem
      • HazardDataRequestItem.longitudes
      • HazardDataRequestItem.latitudes
      • HazardDataRequestItem.request_item_id
      • HazardDataRequestItem.hazard_type
      • HazardDataRequestItem.indicator_id
      • HazardDataRequestItem.indicator_model_gcm
      • HazardDataRequestItem.path
      • HazardDataRequestItem.scenario
      • HazardDataRequestItem.year
      • HazardDataRequestItem.validate_hazard_type()
      • HazardDataRequestItem.event_type
      • HazardDataRequestItem.model_config
    • HazardDataRequest
      • HazardDataRequest.interpolation
      • HazardDataRequest.interpolate_years
      • HazardDataRequest.provider_max_requests
      • HazardDataRequest.items
      • HazardDataRequest.model_config
    • HazardDataResponseItem
      • HazardDataResponseItem.intensity_curve_set
      • HazardDataResponseItem.request_item_id
      • HazardDataResponseItem.hazard_type
      • HazardDataResponseItem.indicator_id
      • HazardDataResponseItem.scenario
      • HazardDataResponseItem.year
      • HazardDataResponseItem.event_type
      • HazardDataResponseItem.model
      • HazardDataResponseItem.model_config
    • HazardDataResponse
      • HazardDataResponse.items
      • HazardDataResponse.model_config
  • physrisk.api.v1.hazard_image
    • TileNotAvailableError
    • Tile
      • Tile.x
      • Tile.y
      • Tile.z
    • HazardImageInfoRequest
      • HazardImageInfoRequest.resource
      • HazardImageInfoRequest.scenario_id
      • HazardImageInfoRequest.year
      • HazardImageInfoRequest.model_config
    • HazardImageInfoResponse
      • HazardImageInfoResponse.all_index_values
      • HazardImageInfoResponse.available_index_values
      • HazardImageInfoResponse.index_display_name
      • HazardImageInfoResponse.index_units
      • HazardImageInfoResponse.max_zoom
      • HazardImageInfoResponse.model_config
    • HazardImageRequest
      • HazardImageRequest.resource
      • HazardImageRequest.scenario_id
      • HazardImageRequest.year
      • HazardImageRequest.colormap
      • HazardImageRequest.format
      • HazardImageRequest.min_value
      • HazardImageRequest.max_value
      • HazardImageRequest.tile
      • HazardImageRequest.index_value
      • HazardImageRequest.model_config
    • HazardImageResponse
      • HazardImageResponse.image
      • HazardImageResponse.model_config
  • physrisk.api.v1.impact_req_resp
    • CalcSettings
      • CalcSettings.hazard_interp
      • CalcSettings.hazard_scope
      • CalcSettings.interpolate_years
      • CalcSettings.hazard_scope_by_indicator
      • CalcSettings.model_config
    • AssetImpactRequest
      • AssetImpactRequest.assets
      • AssetImpactRequest.calc_settings
      • AssetImpactRequest.include_asset_level
      • AssetImpactRequest.include_measures
      • AssetImpactRequest.include_calc_details
      • AssetImpactRequest.use_case_id
      • AssetImpactRequest.provider_max_requests
      • AssetImpactRequest.scenarios
      • AssetImpactRequest.years
      • AssetImpactRequest.scenario
      • AssetImpactRequest.year
      • AssetImpactRequest.model_config
    • RiskMeasureDefinition
      • RiskMeasureDefinition.measure_id
      • RiskMeasureDefinition.label
      • RiskMeasureDefinition.description
      • RiskMeasureDefinition.units
      • RiskMeasureDefinition.model_config
    • RiskScoreValue
      • RiskScoreValue.value
      • RiskScoreValue.label
      • RiskScoreValue.description
      • RiskScoreValue.lower_bound
      • RiskScoreValue.upper_bound
      • RiskScoreValue.model_config
    • ScoreBasedRiskMeasureDefinition
      • ScoreBasedRiskMeasureDefinition.hazard_types
      • ScoreBasedRiskMeasureDefinition.values
      • ScoreBasedRiskMeasureDefinition.underlying_measures
      • ScoreBasedRiskMeasureDefinition.model_config
    • RiskMeasureKey
      • RiskMeasureKey.hazard_type
      • RiskMeasureKey.scenario_id
      • RiskMeasureKey.year
      • RiskMeasureKey.measure_id
      • RiskMeasureKey.hazard_indicator_id
      • RiskMeasureKey.model_config
    • RiskMeasure
      • RiskMeasure.key
      • RiskMeasure.score
      • RiskMeasure.measure_0
      • RiskMeasure.measure_1
      • RiskMeasure.model_config
    • RiskMeasuresForAssets
      • RiskMeasuresForAssets.key
      • RiskMeasuresForAssets.scores
      • RiskMeasuresForAssets.measures_0
      • RiskMeasuresForAssets.measures_1
      • RiskMeasuresForAssets.model_config
    • ScoreBasedRiskMeasureSetDefinition
      • ScoreBasedRiskMeasureSetDefinition.measure_set_id
      • ScoreBasedRiskMeasureSetDefinition.asset_measure_ids_for_hazard
      • ScoreBasedRiskMeasureSetDefinition.score_definitions
      • ScoreBasedRiskMeasureSetDefinition.asset_measure_ids_for_hazard_drilldown
      • ScoreBasedRiskMeasureSetDefinition.model_config
    • RiskMeasures
      • RiskMeasures.measures_for_assets
      • RiskMeasures.measures_for_portfolio
      • RiskMeasures.score_based_measure_set_defn
      • RiskMeasures.measures_definitions
      • RiskMeasures.scenarios
      • RiskMeasures.asset_ids
      • RiskMeasures.model_config
    • CalculationDetails
      • CalculationDetails.hazard_exceedance
      • CalculationDetails.hazard_distribution
      • CalculationDetails.vulnerability_distribution
      • CalculationDetails.hazard_path
      • CalculationDetails.hazard_units
      • CalculationDetails.model_config
    • ImpactKey
      • ImpactKey.hazard_type
      • ImpactKey.scenario_id
      • ImpactKey.year
      • ImpactKey.model_config
    • AssetSingleImpact
      • AssetSingleImpact.model_config
      • AssetSingleImpact.key
      • AssetSingleImpact.impact_type
      • AssetSingleImpact.hazard_indicator_id
      • AssetSingleImpact.impact_distribution
      • AssetSingleImpact.impact_exceedance
      • AssetSingleImpact.impact_mean
      • AssetSingleImpact.impact_std_deviation
      • AssetSingleImpact.impact_semi_std_deviation
      • AssetSingleImpact.calc_details
    • AssetLevelImpact
      • AssetLevelImpact.asset_id
      • AssetLevelImpact.impacts
      • AssetLevelImpact.model_config
    • AssetImpactResponse
      • AssetImpactResponse.asset_impacts
      • AssetImpactResponse.risk_measures
      • AssetImpactResponse.model_config
    • RiskMeasuresHelper
      • RiskMeasuresHelper.get_measure()
      • RiskMeasuresHelper.get_score_details()
      • RiskMeasuresHelper.Key
  • Module contents
• physrisk.api.v2
  • Module contents

Module contents