Simulation
During the simulation of a model
, a Simulation
object is constructed. The field names of the Simulation
object is
model::Model
: The model for which theSimulation
is constructed.path::String
: The path of the directory into which all simulation-related files (log, data files etc.) are saved.logger::AbstractLogger
: The logger of the simulation constructed to log each stage of theSimulation
.state::Symbol
: The state of theSimulation
. Thestate
may be:running
if the simulation is running,:halted
is the simulation is terminated without being completed,:done
if it is terminated.retcode::Symbol
: The return code of the simulation. Theretcode
may be:success
if the simulation is completed without errors,:failed
if the an error occurs during the simulation.
Full API
Causal.Simulation
— TypeSimulation(model; simdir=tempdir(), simname=string(uuid4()), simprefix="Simulation-", logger=SimpleLogger())
Constructs a Simulation
object for the simulation of model
. The Simulation
object is used to monitor the state of the simulation of the model
. simdir
is the path of the directory into which the simulation files(log, data files etc.) are recorded. simname
is the name of the Simulation
and simprefix
is the prefix of the name of the Simulation
. logger
is used to log the simulation steps of the model
. See also: Model
, Logging
Causal.SimulationError
— TypeSimulationError(msg::String)
Thrown when an error occurs during a simulation.
Causal.closelogger
— Functioncloselogger(logger=global_logger())
Closes the logger
the file of the loggger
. See also: setlogger
Causal.report
— Methodreport(simulation::Simulation)
Records the state of the simulation
by writing all its fields into a data file. All the fields of the simulation
is written into file. When the file is read back, the simulation
object is constructed back. The data file is written under the path of the simulation
.
Causal.setlogger
— Methodsetlogger(path, name; setglobal::Bool=true)
Returns a logger. path
is the path and name
is the name of the file of the logger. If setglobal
is true
, the returned logger is a global logger.
Example
julia> logger = setlogger(tempdir(), "mylogger", setglobal=true)
Base.CoreLogging.SimpleLogger(IOStream(<file /tmp/mylogger>), Info, Dict{Any,Int64}())