API Reference

This section provides detailed API documentation for the Inland Consequences packages.

Packages

inland_consequences

The main package containing flood analysis orchestration, vulnerability calculations, and building data handling.

• inland_flood_analysis - Vectorized inland flood analysis orchestrator
• inland_vulnerability - Inland vulnerability function implementation
• raster_collection - Raster input management for multi-return-period analysis
• results_aggregation - Flood results aggregation utilities
• nsi_buildings - NSI (National Structure Inventory) building data handling
• milliman_buildings - Milliman building data handling

Coastal Submodule

• pfracoastal - PFRA coastal flood analysis

sphere.core.schemas

Core schemas and abstract interfaces used across the consequence modeling framework.

• buildings - Base Buildings class with field mapping
• field_mapping - Field mapping utilities for flexible column naming
• abstract_raster_reader - Abstract interface for raster data readers
• abstract_vulnerability_function - Abstract vulnerability function interface
• nsi_buildings - NSI-specific buildings schema