fire.py API

The fire.py file lives in the fire folder and records metadata about the fire event. The file includes the following fields:

name

Type:

str

The name of the fire event. The name should use spaces to separate words (not underscores), and should not end in the word “Fire”. If the fire event consists of multiple sub-fires, then the fire name conventionally should end in the word “Complex”. Note that you can use the --ignore-name option to ignore these naming conventions when running ocelote.

start_date

Type:

str

The starting date of the fire event. This should be a string that follows the ISO 8601 format YYYY-MM-DD.

location

Type:

str

Provides additional spatial context for the fire. This is often a county or National Forest where the fire occurred, but other contexts may also be used.

Important

The location should not include the state or country where the fire occurred, as this informated will be determined automatically from the fire perimeter.

subfires

Type:

list[str]

An optional field for when a fire event consists of multiple subfires. In this case, the field should be a list consisting of the names of the subfires. By default, providing this metadata will cause ocelote to check that the fire name ends with the word “Complex”. However, you can use the --ignore-name option to skip this check.