---
title: "firebehavioR"
output: github_document
---

```{r setup, include=FALSE}
knitr::opts_chunk$set(echo = TRUE)
```

An R package for predicting fire behavior using the Rothermel modelling system or the Crown Fire Initiation & Spread modelling system.

## Features
Fire behavior predictions using:   
* the Rothermel modelling system, similar to BehavePlus, NEXUS, and FuelCalc.  
* the Crown Fire Initiation & Spread modelling system.  

Helper functions which can:  
* Calculate the wind adjustment factor, using a little or alot of site-specific forest canopy information  
* Predict canopy fuels characteristics such as canopy bulk density and canopy fuel load  

Helper data:  
* Stylized surface fuel models  
* Surface fuel moisture scenarios  

## Installation

You can install firebehavioR from GitHub for the development version.  

```
devtools::install_github("zieg9479/firebehavioR")
```

 There are no package dependencies, but you should have r R (>= 3.4.1) installed.
 
## Usage

The vignette in the above references GitHub repo will help you get up and going. 

## Authors
* **Justin Ziegler** - developer and maintainer, Justin.Ziegler@Colostate.edu

## License

GPL (>= 2)
