Spatial Discrete Event Simulation (SpaDES)

Develop and run spatially explicit discrete event simulation models

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) framework that facilitates modularity, and easily enables the user to include additional functionality by running user-built simulation modules (see also SpaDES.tools and SpaDES.experiment). 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.

Getting started

• Getting started guide
• LCC2005 tutorial
• 'SpaDES 4 Dummies' guide
• SpaDES users group
• Vignettes
• Wiki
• Known modules (existing or in development)
• SpaDES Best Practices Google Doc

Workshops

• SpaDES Workshops

Websites

SpaDES metapackage: https://SpaDES.PredictiveEcology.org

Other SpaDES packages:

• quickPlot: https://quickplot.predictiveecology.org/

• reproducible: https://reproducible.predictiveecology.org/

• Require: https://require.predictiveecology.org/

• SpaDES.addins: https://spades-addins.predictiveecology.org

• SpaDES.core: https://spades-core.predictiveecology.org/

• SpaDES.experiment: https://spades-experiment.predictiveecology.org/

• SpaDES.shiny: https://spades-shiny.predictiveecology.org/

• SpaDES.tools: https://spades-tools.predictiveecology.org/

• SpaDES.project: (currently being set up) https://spades-project.predictiveecology.org/

Domain specific packages

• LandR: https://LandR.predictiveecology.org/

A package to accompany the LandR landscape ecosystem modules.

• NetLogoR: https://NetLogoR.predictiveecology.org/

A re-implementation in pure R of the NetLogo dictionary.

Predictive Ecology Blog: https://predictiveecology.org/

Canadian Forest Service Adaptation Toolkit: https://natural-resources.canada.ca/climate-change/climate-change-impacts-forests/forest-change-adaptation-tools/17770

Simple visuals SpaDES_examples repository

Examples for R-savvy users:

Copy the linked .Rmd file to your computer. Open it with a text editor or in RStudio, and run all chunks in R. It is not intended to be knitted; knitting will only output the script.

• LandCoverChange

Installation

Install development libraries: building packages from source requires the appropriate development libraries for your operating system.

• Windows: install Rtools.

• macOS: install Xcode command line tools from the terminal: xcode-select install.

• Debian/Ubuntu Linux: ensure r-base-dev is installed.

See here for more details.

Install suggested packages: the fastshp package can be installed with:

install.packages("fastshp", repos = "https://rforge.net", type = "source")

Current stable release

Install from CRAN:

install.packages("SpaDES")

Install from GitHub:

#install.packages("devtools")
library("devtools")
install_github("PredictiveEcology/SpaDES", dependencies = TRUE) # master

Development version (unstable)

Install from GitHub:

#install.packages("devtools")
library("devtools")
install_github("PredictiveEcology/SpaDES", ref = "development", dependencies = TRUE)

Getting help

Q&A forum is available on the SpaDES Users Google Group. This is the place to ask for help on setting up and running simulations, as well as module development. Please do not file bug reports here.

• Q&A Forum

Reporting bugs

The SpaDES metapackage simply loads a number of other packages from the SpaDES ecosystem. Bug reports should be reported to the specific package in question rather than the metapackage, and should contain a concise reproducible example. Contact us via the package's GitHub site:

• LandR
• quickPlot
• Require
• reproducible
• SpaDES.addins
• SpaDES.core
• SpaDES.experiment
• SpaDES.project
• SpaDES.shiny
• SpaDES.tools

Copyright (C) 2022 Her Majesty the Queen in Right of Canada, as represented by the Minister of Natural Resources Canada.