PredictiveEcology / SpaDES

R package for developing and running Spatial Discrete Event Simulation models
https://spades.predictiveecology.org
Other
55 stars 21 forks source link
r-package simulation-framework simulation-toolkit spatially-explicit-models

Spatial Discrete Event Simulation (SpaDES)

R build status CRAN_Status_Badge CRAN_Release_Date Downloads DOI Codecov test coverage

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

Workshops

Websites

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

Other SpaDES packages:

Domain specific packages

A package to accompany the LandR landscape ecosystem modules.

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.


Installation

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

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.

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:


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