Overview

The ocelote package implements the USGS’s operational postfire debris-flow hazard assessment product. The package is intended for operational USGS personnel. If you would like to run your own hazard assessments, but are not a USGS affiliate, we recommend using the wildcat package instead.

Ocelote is usually run from the command line (CLI), but advanced users can also run ocelote within a Python session. Ocelote currently includes the following commands:

Command	Description
authenticate s3	Sets up credentials for uploading assessments to Amazon Simple Storage Service (S3) for the web map
authenticate sciencebase	Sets up credentials for uploading assessments to ScienceBase
initialize fire	Initializes a folder for a fire event
initialize version	Initializes a folder for an assessment version
download	Downloads assessment datasets from the internet
preprocess	Preprocesses datasets in preparation for an assessment
run	Runs an assessment and exports results to comply with the PWFDF data specification
upload s3	Uploads assessment results to S3 for the web map
upload sciencebase	Uploads assessment results to ScienceBase for permanent archival

We recommend users start by installing ocelote and reading the quickstart guide. You can also learn more about individual commands by reading the API, or by clicking the links in the above table.