Probability Depth

Probability Depth Method

probability.get_depth(
    search_items, 
    csv=False, 
    output_dir='/output'
)

Delivers the flood depth (in centimeters) for flooding to the building footprint broken down by return period and year of annual risk.

The low, mid, high likelihood is returned as [DepthThresholdData] within the associated threshold and year. Available depth thresholds include >0cm, >15cm, and >30cm, returned as [DepthChanceData] and are broken down by the following years within the [DepthChance] model - 2020, 2025, 2030, 2035, 2040, 2045, and 2050.

This method returns an array of ProbabilityDepth product for the given property IDs. Only property IDs are accepted. Optionally creates a csv file.

(More information on the Probability Depth product can be found on the Probability Depth Page on the First Street Foundation API Data Dictionary)

Arguments:

search_items: list/file of SearchItems, property parcels to retrieve probability depth for.
csv: bool, whether to create a CSV for the retrieved data.
output_dir: string, location to output the created CSV (if csv is True).

Example (Command Line):

Call probability.get_depth on a list with 2 FSIDs

python -m firststreet -p probability.get_depth -s 190836953;193139123

Call probability.get_depth on a lat/lng or address

python -m firststreet -p probability.get_depth -s 37.16314,-76.55782;38.50303,-106.72863
python -m firststreet -p probability.get_depth -s "247 Water Street, New York, New York";"135 East 46th Street New York, New York"

Call probability.get_depth on a file of SearchItems

python -m firststreet -p probability.get_depth -s sample_property.txt

Example (Python File):

# Contents of sample.py
# Create a `FirstStreet` object.  
import firststreet
fs = firststreet.FirstStreet("api-key")

# Call probability.get_depth on a list with 2 property FSIDs
probability_depth = fs.probability.get_depth(search_items=[190836953, 193139123])

# Call location.get_summary on a lat/lng or address
probability_depth = fs.probability.get_depth(search_items=[(37.16314,-76.55782)], csv=True)
probability_depth = fs.probability.get_depth(search_items=["247 Water Street, New York, New York"], csv=True)

# Call probability.get_depth on a file of SearchItems
probability_depth = fs.probability.get_depth(search_items="sample.txt", csv=True)