Save scenario object on disk in parquet format using arrow package.

Save scenario object on disk in parquet format using arrow package.

Usage

save_scenario(
  object,
  path = object@path,
  embed_model = NULL,
  embed_datasets = NULL,
  mode = NULL,
  format = get_storage_format(),
  overwrite = TRUE,
  clean_start = FALSE,
  write_log = TRUE,
  verbose = TRUE
)

Arguments

object: scenario object.
path: character. Path to scenario directory.
embed_model: NULL (default: by mode), TRUE, or FALSE. Controls whether the model is embedded in the saved scenario or referenced from the model store (see save_model()). NULL: reference a sealed version holding the model's exact content, embed otherwise. TRUE: always embed (self-contained folder). FALSE: require a sealed version, error otherwise. A referenced save stores only {name, hash, path} and is recorded on the sealed version (list_dependents()); load_scenario() resolves it back.
embed_datasets: the same choice for the big data tables and maps — the geoscale on @settings and, when the model is embedded, its geoscale and its repositories' weather/demand tables (see save_dataset()). NULL (default) references whatever identical content is already in the dataset store; TRUE always embeds; FALSE requires a store hit.
mode: "ref" or "full"; defaults to getOption("energyRt.save_mode", "ref"). "ref" references the model when its exact content is a SEALED version in the model store (seal_model()) and copies it in otherwise; "full" copies the model and the datasets in (a self-contained folder). An explicit embed_model / embed_datasets overrides the mode for its level.
format: file format (currently parquet only, arrow or feather will be implemented in further releases).
overwrite: logical. Overwrite existing scenario directory.
clean_start: logical. Clean scenario directory before saving.
write_log: logical. Write (update) logfile.
verbose: logical. Print messages.

Value

scenario object with most of the slots saved on disk.

Details

This is the only writer of a run's modOut/ store: read_solution() leaves the solution in memory, and without a save it does not survive the session. The store is written for the ACTIVE run — whichever @misc$run names — so saving while one run is active does not persist another's solution. import_solution() does the read and the save in one call.

Examples

if (FALSE) { # \dontrun{
scen_BASE@path # check the scenarion directory
scen_BASE <- save_scenario(scen_BASE) # saving in the default directory
} # }