Config¶

Functions for configuring sober.

config_energyplus ¶

config_energyplus(
    *,
    version=None,
    root=None,
    schema_energyplus=None,
    exec_energyplus=None,
    exec_epmacro=None,
    exec_expandobjects=None,
    exec_readvars=None,
)

Configure EnergyPlus-related file paths.

Three methods to find these paths are available.

If version is specified, the default EnergyPlus installation directory on the current operating system will be used to find all paths.
If version is not specified and root is specified, the user-specified EnergyPlus installation directory will be used to find all paths.
If neither version nor root is specified, each path can be specified separately, where schema_energyplus and exec_energyplus are mandatory.

PARAMETER	DESCRIPTION
`version`	EnergyPlus version. TYPE: `str` DEFAULT: `None`
`root`	EnergyPlus installation directory path. TYPE: `str or path-like object` DEFAULT: `None`
`schema_energyplus`	Energy+.idd file path. TYPE: `str or path-like object` DEFAULT: `None`
`exec_energyplus`	EnergyPlus executable path. TYPE: `str or path-like object` DEFAULT: `None`
`exec_epmacro`	EPMacro executable path. TYPE: `str or path-like object` DEFAULT: `None`
`exec_expandobjects`	ExpandObjects executable path. TYPE: `str or path-like object` DEFAULT: `None`
`exec_readvars`	ReadVarsESO executable path. TYPE: `str or path-like object` DEFAULT: `None`

config_parallel ¶

config_parallel(*, n_processes=None)

Configure parallel-related settings.

PARAMETER	DESCRIPTION
`n_processes`	Number of prcesses to be parallelised, default is the total number of accessible CPU cores minus one. TYPE: `int` DEFAULT: `None`

config_script ¶

config_script(*, exec_python=None)

Configure script language paths.

PARAMETER	DESCRIPTION
`exec_python`	Python executable path, which can be obtained by `sys.executable`. TYPE: `str or path-like object` DEFAULT: `None`