pfdf¶
The pfdf package is a Python library designed to facilitate postfire debris-flow hazard assessments and research. The library provides routines to:
Download assessment datasets
Analyze watersheds
Delineate stream segment networks
Compute stream segment characteristics
Run the debris-flow likelihood models of Staley and others, 2017
Run the potential sediment volume models of Gartner and others, 2014
Classify hazards following Cannon and others, 2010, and
Export results to common GIS formats (such as Shapefiles and GeoJSON)
All routines are optional, and may be configured for a variety of analyses and assessment styles. We note that some coding experience is required to use the routines in this package. As such, pfdf is primarily intended for researchers and developers of hazard assessment tools.
Tip
If you just want to run a hazard assessment, then you may want the wildcat package instead of pfdf. The pfdf library is intended for users who want to build and modify assessment frameworks, whereas wildcat is intended to quickly produce assessments.
Using these docs¶
These docs contain a variety of resources for pfdf users. We recommend most users begin with the Tutorials. The tutorials are a collection of Jupyter notebooks designed to introduce users to pfdf. The main series introduces the components needed to run hazard assessments, and there are advanced tutorials on more specialized topics.
The tutorials are only intended as an introduction, so do not discuss every component of pfdf. After completing the tutorials, users may find the User Guide a useful resource. The guide discusses every module and class in pfdf, with more detailed discussions of the components introduced in the tutorials. Finally, the API is the complete reference guide to pfdf, and describes every command and option in full detail.
This documentation also provides various resources for the pfdf community. These include:
FAQs,
links to commonly used datasets,
contribution guidelines (including a developer guide),
release notes, and
the latest release.
You can find links to these resources in the navigation sidebar.
Citation¶
If you use pfdf for a publication, please consider citing it. Please read the Citation Page for more details.