EOS/docs/_generated/configload.md

Load Prediction Configuration

:::{table} load :widths: 10 20 10 5 5 30 :align: left

Name	Environment Variable	Type	Read-Only	Default	Description
loadakkudoktor	EOS_LOAD__LOADAKKUDOKTOR	LoadAkkudoktorCommonSettings	rw	required	LoadAkkudoktor provider settings.
loadimport	EOS_LOAD__LOADIMPORT	LoadImportCommonSettings	rw	required	LoadImport provider settings.
loadvrm	EOS_LOAD__LOADVRM	LoadVrmCommonSettings	rw	required	LoadVrm provider settings.
provider	EOS_LOAD__PROVIDER	Optional[str]	rw	None	Load provider id of provider to be used.
providers		list[str]	ro	N/A	Available load provider ids.
:::

Example Input

   {
       "load": {
           "provider": "LoadAkkudoktor",
           "loadakkudoktor": {
               "loadakkudoktor_year_energy_kwh": null
           },
           "loadvrm": {
               "load_vrm_token": "your-token",
               "load_vrm_idsite": 12345
           },
           "loadimport": {
               "import_file_path": null,
               "import_json": null
           }
       }
   }

Example Output

   {
       "load": {
           "provider": "LoadAkkudoktor",
           "loadakkudoktor": {
               "loadakkudoktor_year_energy_kwh": null
           },
           "loadvrm": {
               "load_vrm_token": "your-token",
               "load_vrm_idsite": 12345
           },
           "loadimport": {
               "import_file_path": null,
               "import_json": null
           },
           "providers": [
               "LoadAkkudoktor",
               "LoadAkkudoktorAdjusted",
               "LoadVrm",
               "LoadImport"
           ]
       }
   }

Common settings for load forecast VRM API

:::{table} load::loadvrm :widths: 10 10 5 5 30 :align: left

Name	Type	Read-Only	Default	Description
load_vrm_idsite	int	rw	12345	VRM-Installation-ID
load_vrm_token	str	rw	your-token	Token for Connecting VRM API
:::

Example Input/Output

   {
       "load": {
           "loadvrm": {
               "load_vrm_token": "your-token",
               "load_vrm_idsite": 12345
           }
       }
   }

Common settings for load data import from file or JSON string

:::{table} load::loadimport :widths: 10 10 5 5 30 :align: left

Name	Type	Read-Only	Default	Description
import_file_path	Union[str, pathlib.Path, NoneType]	rw	None	Path to the file to import load data from.
import_json	Optional[str]	rw	None	JSON string, dictionary of load forecast value lists.
:::

Example Input/Output

   {
       "load": {
           "loadimport": {
               "import_file_path": null,
               "import_json": "{\"load0_mean\": [676.71, 876.19, 527.13]}"
           }
       }
   }

Common settings for load data import from file

:::{table} load::loadakkudoktor :widths: 10 10 5 5 30 :align: left

Name	Type	Read-Only	Default	Description
loadakkudoktor_year_energy_kwh	Optional[float]	rw	None	Yearly energy consumption (kWh).
:::

Example Input/Output

   {
       "load": {
           "loadakkudoktor": {
               "loadakkudoktor_year_energy_kwh": 40421.0
           }
       }
   }