Internally used, package-specific options. All options will prioritize R options() values, and fall back to environment variables if undefined. If neither the option nor the environment variable is set, a default value is used.
Checking Option Values
Option values specific to energyRt can be
accessed by passing the package name to env.
Options
- gams_path
-
Path to the GAMS installation directory. Prefixed to the gams command when solving with a GAMS backend. If unset, gams is resolved on the session PATH.
- default:
NULL- option:
en.gams_path
- envvar:
ENERGYRT_GAMS_PATH (evaluated if possible, raw string otherwise)
- gdxlib_path
-
Path to the GAMS Data Exchange (GDX) library, used to read and write *.gdx files. If unset, gams_path is used instead.
- default:
NULL- option:
en.gdxlib_path
- envvar:
ENERGYRT_GDXLIB_PATH (evaluated if possible, raw string otherwise)
- python_path
-
Path to the Python installation or environment used by the Pyomo backend. Prefixed to the python command. If unset, python is resolved on the session PATH.
- default:
NULL- option:
en.python_path
- envvar:
ENERGYRT_PYTHON_PATH (evaluated if possible, raw string otherwise)
- julia_path
-
Path to the Julia installation used by the JuMP backend. Prefixed to the julia command. If unset, julia is resolved on the session PATH.
- default:
NULL- option:
en.julia_path
- envvar:
ENERGYRT_JULIA_PATH (evaluated if possible, raw string otherwise)
- glpk_path
-
Path to a standalone GLPK installation containing the glpsol executable. If unset, glpsol is auto-detected on the session PATH -- which on Windows finds the copy bundled with Rtools.
- default:
NULL- option:
en.glpk_path
- envvar:
ENERGYRT_GLPK_PATH (evaluated if possible, raw string otherwise)
- mosox_path
-
Path to the directory containing the mosox executable.
- default:
NULL- option:
en.mosox_path
- envvar:
ENERGYRT_MOSOX_PATH (evaluated if possible, raw string otherwise)
- neos_email
-
Email address for NEOS Server job submission (required by NEOS). Read from the NEOS_EMAIL environment variable if the option is unset.
- default:
NULL- option:
en.neos_email
- envvar:
NEOS_EMAIL (evaluated if possible, raw string otherwise)
- neos_endpoint
-
XML-RPC endpoint of the NEOS Server.
- default:
"https://neos-server.org:3333"- option:
en.neos_endpoint
- envvar:
ENERGYRT_NEOS_ENDPOINT (evaluated if possible, raw string otherwise)
- solver
-
Default solver specification, used when a scenario carries none. A named list, normally one of the solver_options presets.
- default:
list(name = "glpk", lang = "GLPK")- option:
en.solver
- envvar:
ENERGYRT_SOLVER (evaluated if possible, raw string otherwise)
- scenarios_path
-
Root directory for scenario folders. Scenario paths and solver working directories are built underneath it.
- default:
"scenarios/"- option:
en.scenarios_path
- envvar:
ENERGYRT_SCENARIOS_PATH (evaluated if possible, raw string otherwise)
- default_registry
-
Where the registry of repositories, models and scenarios lives: a list with the object name and the environment env holding it.
- default:
list(name = "registry", env = ".scen")- option:
en.default_registry
- envvar:
ENERGYRT_DEFAULT_REGISTRY (evaluated if possible, raw string otherwise)
- arrow_format
-
Default Arrow exchange format for the JuMP/Pyomo solvers: 'feather' (IPC), 'parquet', or 'csv'.
- default:
"feather"- option:
en.arrow_format
- envvar:
ENERGYRT_ARROW_FORMAT (evaluated if possible, raw string otherwise)
- arrow_compression
-
Arrow compression codec: 'zstd', 'lz4', or 'uncompressed'.
- default:
"zstd"- option:
en.arrow_compression
- envvar:
ENERGYRT_ARROW_COMPRESSION (evaluated if possible, raw string otherwise)
- arrow_compression_level
-
Arrow compression level (codec-dependent; ZSTD supports 1-22).
- default:
15L- option:
en.arrow_compression_level
- envvar:
ENERGYRT_ARROW_COMPRESSION_LEVEL (evaluated if possible, raw string otherwise)
- verbose
-
Verbosity level: 0 silent, 1 progress messages, 2 and above for increasingly detailed reporting. TRUE/FALSE are accepted and read as 1/0. Test with isVerbose(level).
- default:
0- option:
en.verbose
- envvar:
ENERGYRT_VERBOSE (evaluated if possible, raw string otherwise)
- debug
-
Debug level, in the same 0/1/2 form as verbose. Enables internal consistency warnings that are silent in normal use. Test with isDebug(level).
- default:
0- option:
en.debug
- envvar:
ENERGYRT_DEBUG (evaluated if possible, raw string otherwise)
- progress_bar
-
Whether long-running operations display a progress bar. Set through show_progress_bar() / set_progress_bar().
- default:
TRUE- option:
en.progress_bar
- envvar:
ENERGYRT_PROGRESS_BAR (evaluated if possible, raw string otherwise)