Input and Output

These functions are responsible for reading in all model configurations (passed by config file or commandline), administrating them during a run, and printing or plotting any output.

input.jl

Persefone.flattenTOMLMethod
flattenTOML(dict)

An internal utility function to convert the two-dimensional dict returned by TOML.parsefile() into a one-dimensional dict, so that instead of writing settings["domain"]["param"] one can use settings["domain.param"]. Can be reversed with prepareTOML.

source
Persefone.getsettingsFunction
getsettings(configfile, seed=nothing)

Combines all configuration options to produce a single settings dict. Precedence: commandline parameters - user config file - default values

source
Persefone.@paramMacro
@param(domainparam)

Return a configuration parameter from the global settings. The argument should be in the form <domain>.<parameter>, for example @param(core.outdir). Possible values for <domain> are core, nature, farm, or crop. For a full list of parameters, see src/parameters.toml.

Note: this macro only works in a context where the model object is available!

source
Persefone.@randMacro
@rand(args...)

Return a random number or element from the sample, using the model RNG. This is a utility wrapper that can only be used a context where the model object is available.

source
Persefone.@shuffle!Macro
@shuffle!(collection)

Shuffle the given collection in place, using the model RNG. This is a utility wrapper that can only be used a context where the model object is available.

source

output.jl

Persefone.DataOutputType
DataOutput

A struct for organising model output. This is used to collect model data in an in-memory dataframe or for CSV output. Submodels can register their own output functions using newdataoutput!.

Struct fields: - name: a string identifier for the data collection (used as file name) - header: a list of column names - outputfunction: a function that takes a model object and returns data values to record (formatted as a vector of vectors) - frequency: how often to call the output function (daily/monthly/yearly/end/never) - plotfunction: a function that takes a model object and returns a Makie figure object (optional)

source
Persefone.modelloggerMethod
modellogger(loglevel, outdir)

Create a logger object that writes output both to screen and to a logfile. This object is stored as model.logger and can then be used with with_logger(). Note: requires createdatadir to be run first.

source
Persefone.newdataoutput!Function
newdataoutput!(model, name, header, outputfunction, frequency)

Create and register a new data output. This function must be called by all submodels that want to have their output functions called regularly.

source
Persefone.outputdataFunction
outputdata(model, force=false)

Cycle through all registered data outputs and activate them according to their configured frequency. If force is true, activate all outputs regardless of their configuration.

source
Persefone.prepareTOMLMethod
prepareTOML(dict)

An internal utility function to re-convert the one-dimensional dict created by flattenTOML into the two-dimensional dict needed by TOML.print, and convert any data types into TOML-compatible types where necessary.

source
Persefone.saveinputfilesMethod
saveinputfiles(model)

Copy all input files into the output directory, including the actual parameter settings used. This allows replicating a run in future.

source
Persefone.savemodelobjectMethod
savemodelobject(model, filename)

Serialise a model object and save it to file for later reference. Includes the current model and Julia versions for compatibility checking.

WARNING: produces large files (>100 MB) and takes a while to execute.

source
Persefone.visualiseoutputFunction
visualiseoutput(model)

Cycle through all data outputs and call their respective plot functions, saving each figure as a PDF.

source
Persefone.withtestloggerMethod
withtestlogger(model)

Replace the model logger with the currently active logger. This is intended to be used in the testsuite to circumvent a Julia issue, where @test_logs doesn't work with local loggers.

source

makieplots.jl

Persefone.gettickmarksMethod
gettickmarks(dates)

Given a vector of dates, construct a selection to use as tick mark locations. Helper function for [populationtrends](@ref)

source
Persefone.populationtrendsMethod
populationtrends(model)

Plot a line graph of population sizes of each species over time. Returns a Makie figure object.

source
Persefone.visualisemapFunction
visualisemap(model, date, landcovermap)

Draw the model's land cover map and plot all individuals as points on it at the specified date. If no date is passed, use the last date for which data are available. Optionally, you can pass a landcover map image (this is needed to reduce the frequency of disk I/O for Persefone Desktop). Returns a Makie figure object.

source