Skip to main content

fireSense Manual: v. 0.0.0.9000

1 fireSense Module

made-with-Markdown

1.0.0.1 Authors:

Jean Marchal [aut, cre], Alex M. Chubaty [ctb]

1.1 Module Overview

A landscape fire model sensitive to environmental changes (e.g., weather and land cover) (Marchal et al. 2017b, a; 2019).

1.1.1 Module summary

Provide a brief summary of what the module does / how to use the module.

Module documentation should be written so that others can use your module. This is a template for module documentation, and should be changed to reflect your module.

1.1.2 Module inputs and parameters

Table 1.1 shows the full list of module inputs.

Table 1.1: Table 1.2: List of fireSense input objects and their description.
objectName objectClass desc sourceURL
fireSense_IgnitionPredicted SpatRaster A SpatRaster of ignition probabilities. NA
fireSense_EscapePredicted SpatRaster A SpatRaster of escape probabilities. NA
fireSense_SpreadPredicted SpatRaster A SpatRaster of spread probabilities. NA

Summary of user-visible parameters (Table 1.3)

Table 1.3: Table 1.4: List of fireSense parameters and their description.
paramName paramClass default min max paramDesc
plotIgnitions logical FALSE NA NA whether to plot ignitions, escapes, and burns
.plotInitialTime numeric NA NA NA optional. When to start plotting.
.plotInterval numeric NA NA NA optional. Interval between plot events.
.runInitialTime numeric 0 NA NA time to simulate initial fire
.runInterval numeric NA NA NA optional. Interval between two runs of this module, expressed in units of simulation time. By default, 1 year.
.saveInitialTime numeric NA NA NA optional. When to start saving output to a file.
.saveInterval numeric NA NA NA optional. Interval between save events.
whichModulesToPrepare character fireSens…. NA NA Which fireSense predict modules to prep? Defaults to all 3. Must include fireSense_IgnitionPredict.

1.1.3 Events

  • ignite fires
  • determine which fires escape
  • spread escaped fires
  • save
  • plot

1.1.4 Plotting

  • Burn map: Pixels burned this timestep.
  • Cumulative burn map: Number of times each pixel burned during the simulation..

1.1.5 Saving

  • burnMap: A RasterLayer describing how which pixels burned this timestep.
  • burnMapCumul: A RasterLayer describing how many times each pixel burned over the course of the simulation.

1.1.6 Module outputs

Description of the module outputs (Table 1.5).

Table 1.5: Table 1.6: List of fireSense outputs and their description.
objectName objectClass desc
burnDT data.table Data table with pixel IDs of most recent burn.
burnMap SpatRaster A raster of cumulative burns
burnSummary data.table Describes details of all burned pixels.
rstAnnualBurnID SpatRaster annual raster whose values distinguish individual fires
rstCurrentBurn SpatRaster A binary raster with 1 values representing burned pixels.

1.1.7 Usage 

Require(c("SpaDES.core", "SpaDES.tools"))

set.seed(1)

nx <- ny <- 100L
n <- nx * ny
r <- raster(nrows = ny, ncols = nx, xmn = -nx/2, xmx = nx/2,
    ymn = -ny/2, ymx = ny/2)

# Create a map ignition probabilities
ignitionProbRaster <- gaussMap(r, scale = 10, var = 1e-04, speedup = nx/500,
    inMemory = TRUE)

# Create a map of escape probabilities
escapeProbRaster <- gaussMap(r, scale = 50, var = 0.01, speedup = nx/500,
    inMemory = TRUE)

# Create a map of spread probabilities
spreadProbRaster <- gaussMap(r, scale = 300, var = 0.05, speedup = nx/500,
    inMemory = TRUE)

# outputDir <- file.path(tempdir(), 'outputs')
times <- list(start = 1, end = 100, timeunit = "year")

modules <- list("fireSense")

# Pass objects found in the global environment to the
# simList environment
objects <- list(ignitionProbRaster = ignitionProbRaster, escapeProbRaster = escapeProbRaster,
    spreadProbRaster = spreadProbRaster)

# paths <- list( # cachePath = file.path(outputDir,
# 'cache'), modulePath = '..'  # inputPath = inputDir, #
# outputPath = outputDir )

paths <- list(modulePath = "..")

mySim <- simInit(times = times, params = parameters, modules = modules,
    objects = objects, paths = paths)

spades(mySim)

1.2 References