Getting started with SpaDES
Author: Alex M. Chubaty

# Getting started with `SpaDES`

#### Alex M. Chubaty

#### Eliot J. B. McIntire

#### April 17 2024

# 1 Introduction

`SpaDES` is a metapackage for implementing a variety of event-based models, with a focus on spatially explicit models. These include raster-based, event-based, and agent-based models. The core simulation components (provided by `SpaDES.core`) are built upon a discrete event simulation (DES; see Matloff (2011) ch 7.8.3 https://nostarch.com/artofr.htm) framework that facilitates modularity, and easily enables the user to include additional functionality by running user-built simulation modules (see also `SpaDES.tools`). Included are numerous tools to visualize rasters and other maps (via `quickPlot`), and caching methods for reproducible simulations (via `reproducible`). Additional functionality is provided by the `SpaDES.addins` and `SpaDES.shiny` packages (see below).

Bug reports:

- `quickPlot` package: https://github.com/PredictiveEcology/quickPlot/issues
- `reproducible` package: https://github.com/PredictiveEcology/reproducible/issues
- `SpaDES.addins` package: https://github.com/PredictiveEcology/SpaDES.addins/issues
- `SpaDES.core` package: https://github.com/PredictiveEcology/SpaDES.core/issues
- `SpaDES.shiny` package: https://github.com/PredictiveEcology/SpaDES.shiny/issues
- `SpaDES.tools` package: https://github.com/PredictiveEcology/SpaDES.tools/issues

Module repository: https://github.com/PredictiveEcology/SpaDES-modules

Wiki: https://github.com/PredictiveEcology/SpaDES/wiki

## 1.1 The `SpaDES.core` package:

The core discrete event simulation framework. See `?SpaDES.core::SpaDES.core`, and the vignettes therein (`browseVignettes()`).

## 1.2 The `SpaDES.tools` package:

Additional utilities for developing ecological simulation models. See `?SpaDES.tools::SpaDES.tools`.

## 1.3 The `SpaDES.addins` package:

A set of RStudio addins to assist with `SpaDES` module development.

## 1.4 The `SpaDES.shiny` package:

Utilities for developing and running `shiny`-based app interfaces to `SpaDES` simulations. (Note this package is still under development and is not yet available on CRAN.)

## 1.5 The `quickPlot` package:

The core `SpaDES` plotting engine, build upon speed and modularity.

## 1.6 The `reproducible` package:

Provides several aspects of reproducible simulations, including simulation caching.