Simulation

The core and world directories hold source files that are important for all submodels, including scheduling, landscape, weather, and input/output functions.

simulation.jl

This file includes the basal functions for initialising and running simulations.

Persefone.finalise!Method
finalise!(model)

Wrap up the simulation. Currently doesn't do anything except print some information.

source
Persefone.initialiseFunction
initialise(config=PARAMFILE, seed=nothing)

Initialise the model: read in parameters, create the output data directory, and instantiate the AgentBasedModel object(s). Optionally allows specifying the configuration file and overriding the seed parameter. This returns a single model object, unless the config file contains multiple values for one or more parameters, in which case it creates a full-factorial simulation experiment and returns a vector of model objects.

source
Persefone.initmodelMethod
initmodel(settings)

Initialise a model object using a ready-made settings dict. This is a helper function for initialise().

source
Persefone.paramscanMethod
paramscan(settings)

Create a list of settings dicts, covering all possible parameter combinations given by the input settings (i.e. a full-factorial experiment). This is a helper function for initialise().

source
Persefone.simulateFunction
simulate(config=PARAMFILE, seed=nothing)

Initialise one or more model objects and carry out a full simulation experiment, optionally specifying a configuration file and a seed for the RNG.

This is the default way to run a Persefone simulation.

source
Persefone.simulate!Method
simulate!(model)

Carry out a complete simulation run using a pre-initialised model object.

source

landscape.jl

This file manages the landscape maps that underlie the model.

Persefone.FarmEventType
FarmEvent

A data structure to define a landscape event, giving its type, spatial extent, and duration.

source
Persefone.PixelType
Pixel

A pixel is a simple data structure to combine land use and ownership information in a single object. The model landscape consists of a matrix of pixels. (Note: further landscape information may be added here in future.)

source
Persefone.createevent!Function
createevent!(model, pixels, name, duration=1)

Add a farm event to the specified pixels (a vector of position tuples) for a given duration.

source
Persefone.distancetoMethod
distanceto(pos, model, habitatdescriptor)

Calculate the distance from the given location to the closest location matching the habitat descriptor function. Caution: can be computationally expensive!

source
Persefone.distancetoMethod
distanceto(pos, model, habitattype)

Calculate the distance from the given location to the closest habitat of the specified type. Caution: can be computationally expensive!

source
Persefone.distancetoedgeMethod
distancetoedge(pos, model)

Calculate the distance from the given location to the closest neighbouring habitat. Caution: can be computationally expensive!

source
Persefone.farmplotMethod
farmplot(position, model)

Return the farm plot at this position, or nothing if there is none (utility wrapper).

source
Persefone.initlandscapeMethod
initlandscape(landcovermap, farmfieldsmap)

Initialise the model landscape based on the map files specified in the configuration. Returns a matrix of pixels.

source
Persefone.landcoverMethod
landcover(position, model)

Return the land cover class at this position (utility wrapper).

source

weather.jl

This file reads in weather data and makes it available to the model.

Persefone.initweatherMethod
initweather(weatherfile, startdate, enddate)

Load a weather file, extract the values that are relevant to this model run (specified by start and end dates), and return a dictionary of Weather objects mapped to dates.

Note: This requires a weather file in the format produced by data/extract_weather_data.R.

source