run_eta {clockSim}R Documentation

Run time estimate for an Odin model run.

Description

Perform test runs of an Odin model with the specified run parameters and return measured run time for planning large-scale simulation repeats and/or model parameter scans.

Usage

run_eta(odin_model, ...)

Arguments

odin_model

An Odin model ⁠R6 <odin_model>⁠

...

Passed to ⁠$run(...)⁠

Value

Estimated run time and resource measured by test run.

Examples

model <- getOdinGen()$continuous_LG$new()
time_hr <- seq(from = 0, to = 24 * 20, by = 1)
run_eta(model, time_hr) # Tell you median run time of simulation

[Package clockSim version 0.1.2 Index]