Simplace Documentation

closeProject(simplace)

Closes the actual Simplace project

simid = createSimulation(simplace, parameterList)

Creates a simulation and substitute parameters.

Returns the id of the currently created simulation.

Arguments

• simplace handle to the framework returned by initSimplace
• parameterList::Dict a dictionary where the keys correspond to parameter names
• queue::Bool is the simulation added to existing list or does it starts a new list

Examples

Create two simulations and run them

createSimulation(sh, Dict("vLUE" => 3.0))
createSimulation(sh, Dict("vLUE" => 3.2))
runSimulations(sh)

Create a new simulation, but remove previous simulations

createSimulation(sh, Dict("vLUE" => 3.1), false)
runSimulations(sh)

installDir = findFirstSimplaceInstallation()

Finds first installation of Simplace

installDirs = findSimplaceInstallations()

Returns a list of simplace installation folders.

The function checks in common locations if there are simplace_core, simplace_modules and (optionally) simplace_run subfolders.

One can give also a list of own candidate folders. Using autodetection makes the scripts more portable.

Arguments

• directories::Union{String, Vector{String}} List of potential folders
• tryStandardDirs::Bool searches in common places like ~/workspace or d:/workspace/
• firstMatchOnly::Bool returns only the first folder that matches
• simulationDir::String name of the folder where simulations are stored
• ignoreSimulationDir::Bool ignores the existance of simulationDir in candidate folder

dtypes = getDatatypesOfResult(result)

Get the datatypes of the simulation result variables

result = getResult(simplace, outputId)

Fetch output from a simulation.

Arguments

• simplace handle to the framework returned by initSimplace
• outputId::String output id defined in the simulation setup (solution or project)
• simulationId::String optional id of the simulation, default "" returns result of all simulations

Examples

runSimulations(sh)
result = getResult(sh, "PhenologyOutput")
data = resultToDict(result)

dirs = getSimplaceDirectories(simplace)

Get the directories (work-, output-, projects- and data-dir)

ids = getSimulationIDs(simplace)

Get IDs of the simulations in the simulation list

units = getUnitsOfResult(result)

Get the units of the simulation result variables

names = getVariablenamesOfResult(result)

Get the variable names of simulation result

sh = initSimplace(installDir, workDir, outputDir)

Initializes the Java Virtual Machine and instantiates the SimplaceWrapper object.

The function returns a handle to the Simplace framework which has to be used for subsequent function calls to the framework.

Arguments

• installDir::String - folder where the subfolders simplace_core and simplace_modules

are located.

• workDir::String - folder where simulation data and parameter files are located
• outputDir::String - folder where simulation results are written
• additionalClasspathList::Union{String, Vector{String}} - list of additional classpaths
• javaParameters::Union{String, Vector{String}} - parameters to initialise the JVM (e.g. amount of memory the JVM should use)

Examples

sh = initSimplace("~/ws/", "~/ws/simplace_run/simulation/", "~/output/")
openProject(sh, "~/ws/simplace_run/simulation/example/Simulation.sol.xml")
runProject(sh)
closeProject(sh)

sh = initSimplaceDefault(setting)

Initialises Simplace with work- and outputdir for different settings.

Available settings are "run", "modules", "lapclient" and "wininstall".

• run: use first simplace installation with workdir "simplace_run/simulation/" (default)
• modules: use first simplace installation with workdir "simplace_modules/test/"
• lapclient: use first simplace installation with workdir "lapclient/data/"
• wininstall: use the local or system installation of Simplace GUI with workdir "SIMPLACE_WORK" in the users home directory

openProject(simplace, solution)

Opens a Simplace project from a solution and optional project file

Arguments

• simplace handle to the framework returned by initSimplace
• solution::String path to a solution file (.sol.xml)
• project::String optional path to a project file (.proj.xml) - default "" means no project
• parameterList::Dict a dictionary where the keys correspond to parameter names

Examples

param = Dict("startdate" => "2020-01-01", "vLUE" => 3.0)
openProject(sh, "Yield.sol.xml", "", param)

resetSimulationQueue(simplace)

Clears the list of simulations

data = resultToDict(result, from::Integer = 0, to::Integer = 0)

Convert simulation result to Dict()

If from and to are given, then only the according subset of data is returned. If the expand argument is set to false, then array values are not converted but returned as java object arrays.

runProject(simplace)

Runs the opened project

runSimulations(simplace, selectsimulation::Bool=false)

Run the created simulations in the simulation list.

setAllSimulationValues(simplace, 
parameterList::Vector{<:Dict} = Vector{Dict}())

Set the values for all simulations.

setCheckLevel(simplace, level::String)

Sets the check level of the framework

setLogLevel(level::String)

Sets the log level of the framework

Valid log levels - sorted by verbosity - are "FATAL", "ERROR", "WARN", "INFO" and "DEBUG".

setProjectLines(simplace, lines)

Sets the lines of the project data files that should be used when running a project.

Arguments

• simplace handle to the framework returned by initSimplace
• lines::String - string with line numbers or ranges of lines, separated by comma, e.g. "2,5,7,10-15,30"

Examples

setProjectLines(sh, "2,5,7,10-15,30")
runProject(sh)

setSimplaceDirectories(simplace; 
WorkDir::String = "", 
OutputDir::String = "", 
ProjectsDir::String = "", 
DataDir::String = "" )

Set working-, output-, projects- and data-directory

setSimulationValues(simplace,  parameterList::Dict = Dict(), 
simulationNumber::Integer = 1)

Set the values of a simulation.

setSlotCount(count::Integer)

Sets number of used CPUs

stepAllSimulations(simplace, 
count::Integer = 1,
filter::Vector{String} = Vector{String}(),
parameterList::Vector{<:Dict} = Vector{Dict}())

Runs all queued simulations for count days.

stepSimulation(simplace, 
count::Integer = 1,
filter::Vector{String} = Vector{String}(),
parameterList::Dict = Dict(), 
simulationNumber::Integer = 1)

Performs a simulation for count days.

varmapToDict(varmap, expand = true)

Convert simulation result to Dict()

If the expand argument is set to false, then array values are not converted but returned as java object arrays.