pwfdf-api

The pwfdf-api provides software tools to search, query, and download assessments from the PWFDF collection. The PWFDF collection is the U.S. Geological Survey’s (USGS) official collection of post-wildfire debris-flow hazard assessments. These assessments are produced in response to elevated debris-flow hazards following wildfire events, and are intended to assist federal, state, and local agencies in planning for postfire hazards. The collection contains all assessments produced since 2025 and is hosted on the ScienceBase data catalog.

This package provides command line and Python interfaces to:

• Search the PWFDF collection for assessments that match various criteria

• Download assessment datasets and

• Query assessment metadata

and is intended to support programmatic interactions with the archive.

Using these docs

These docs contain a variety of resources for pwfdf-api users. The User Guide is designed to introduce new users to the package and is usually the best place to start. The user guide should be sufficient for most users, but the Advanced Topics section also covers some less common use cases. The API is the complete reference guide to using pwfdf-api, and includes sections for both the command line and Python interfaces.

Finally, you can find links to:

• Citation info

• Contribution guidelines

• Legal documents

• Release notes and

• The latest release

under the Resources and Releases sections of the navigation sidebar.