viewDefaultOptimArgs: Prints the default optimisation arguments

In foreSIGHT: Systems Insights from Generation of Hydroclimatic Timeseries

Prints the default optimisation arguments

Description

viewDefautOptimArgs() prints the default values of optimisation arguments (optimisationArguments) used by generateScenarios

Usage

viewDefaultOptimArgs(optimizer = "RGN")

Arguments

optimizer

A string for the numerical optimizer. Default optimizer is 'RGN'.

Details

This a helper function that prints the default values of the optimisation arguments. The user may specify alternate values of these arguments in fields named according to the corresponding argument name nested under optimisationArguments in a JSON file to use as the controlFile input to the generateScenarios function.

See Also

writeControlFile

Examples

# To view the default optimisation arguments
viewDefaultOptimArgs()

foreSIGHT documentation built on Oct. 19, 2023, 9:08 a.m.