README.md

pyrolib

pyrolib is a tool library for Méso-NH/Blaze model. pyrolib provides python tools for the following purposes:

• Generation of the FuelMap.nc file by using a Méso-NH namelist and the initialisation file of a Méso-NH/Blaze run.
• FireFlux I exeprimental fire data processing.
• Development of numerical methods for the Blaze fire model.

Installation

Install pyrolib from PyPI's:

pip install pyrolib

Usage

pyrolib is separated into several sub-libraries for each of the objectives mentioned above, respectively:

• pyrolib.fuelmap
• pyrolib.firefluxpost
• pyrolib.blaze

Fuel database

pyrolib relies on a fuel container object called a FuelDatabase. A FuelDatabase is a 2 level nested dictionary-like class. The first level corresponds to an explicit fuel name (like "tall_grass"). This fuel can be described by several methods that are related to a rate of spread model (for example Rothermel or Balbi). Each description is related to a Fuel class (RothermelFuel or BalbiFuel) and constitutes the second level of the database.

TheFireFluxI FuelDatabase contains for example the following:

* FireFluxI
    < tall_grass > available for:
      - BalbiFuel fuel class

The list of FuelDatabase contained in pyrolib can be accessed through the cli pyrolib-fm list-fuel-databases.

A user database can be saved in a .yml file. See example examples/fuel_database.

Méso-NH compliance

The current version of pyrolib is compliant with Méso-NH from version 5.6.0 to version 5.6.0.

Acknowledgements

This library is part of the ANR FireCaster project (2017-2021, ANR-16-CE04-0006, FIRECASTER).