EOS/docs/_generated/configelecprice.md

Electricity Price Prediction Configuration

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

Name	Environment Variable	Type	Read-Only	Default	Description
charges_kwh	EOS_ELECPRICE__CHARGES_KWH	Optional[float]	rw	None	Electricity price charges [€/kWh]. Will be added to variable market price.
elecpriceimport	EOS_ELECPRICE__ELECPRICEIMPORT	ElecPriceImportCommonSettings	rw	required	Import provider settings.
energycharts	EOS_ELECPRICE__ENERGYCHARTS	ElecPriceEnergyChartsCommonSettings	rw	required	Energy Charts provider settings.
provider	EOS_ELECPRICE__PROVIDER	Optional[str]	rw	None	Electricity price provider id of provider to be used.
providers		list[str]	ro	N/A	Available electricity price provider ids.
vat_rate	EOS_ELECPRICE__VAT_RATE	Optional[float]	rw	1.19	VAT rate factor applied to electricity price when charges are used.
:::

Example Input

   {
       "elecprice": {
           "provider": "ElecPriceAkkudoktor",
           "charges_kwh": 0.21,
           "vat_rate": 1.19,
           "elecpriceimport": {
               "import_file_path": null,
               "import_json": null
           },
           "energycharts": {
               "bidding_zone": "DE-LU"
           }
       }
   }

Example Output

   {
       "elecprice": {
           "provider": "ElecPriceAkkudoktor",
           "charges_kwh": 0.21,
           "vat_rate": 1.19,
           "elecpriceimport": {
               "import_file_path": null,
               "import_json": null
           },
           "energycharts": {
               "bidding_zone": "DE-LU"
           },
           "providers": [
               "ElecPriceAkkudoktor",
               "ElecPriceEnergyCharts",
               "ElecPriceImport"
           ]
       }
   }

Common settings for Energy Charts electricity price provider

:::{table} elecprice::energycharts :widths: 10 10 5 5 30 :align: left

Name	Type	Read-Only	Default	Description
bidding_zone	<enum 'EnergyChartsBiddingZones'>	rw	EnergyChartsBiddingZones.DE_LU	Bidding Zone: 'AT', 'BE', 'CH', 'CZ', 'DE-LU', 'DE-AT-LU', 'DK1', 'DK2', 'FR', 'HU', 'IT-NORTH', 'NL', 'NO2', 'PL', 'SE4' or 'SI'
:::

Example Input/Output

   {
       "elecprice": {
           "energycharts": {
               "bidding_zone": "AT"
           }
       }
   }

Common settings for elecprice data import from file or JSON String

:::{table} elecprice::elecpriceimport :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 elecprice data from.
import_json	Optional[str]	rw	None	JSON string, dictionary of electricity price forecast value lists.
:::

Example Input/Output

   {
       "elecprice": {
           "elecpriceimport": {
               "import_file_path": null,
               "import_json": "{\"elecprice_marketprice_wh\": [0.0003384, 0.0003318, 0.0003284]}"
           }
       }
   }