version.py API

The version.py file lives in the assessment folder and records metadata on the assessment version. The file includes the following fields:

version

Type:

str

The version number for the assessment. This should follow the format X.Y, where X and Y are integers. Note that this field is auto-populated when you initialize a new assessment version.

note

Type:

str

A note indicating the reason for this assessment version. For version 1.0, this will auto-populate to “Initial assessment”. For all other version numbers, the user will need to provide the note. For example, if you are updating an assessment to leverage improved burn severity data, then indicate that in the note.