Mirrors/EOS
1
0
Fork 0
mirror of https://github.com/Akkudoktor-EOS/EOS.git synced 2025-11-21 04:46:31 +00:00
Code Issues Actions 5 Packages Projects Releases Wiki Activity
Files
edff649a5edcf4da8d16b4a174596914db1cccfd
EOS/docs/_generated/configelecprice.md
Bobby Noelte 7bf9dd723e
Some checks failed
docker-build / platform-excludes (push) Has been cancelled
Details
pre-commit / pre-commit (push) Has been cancelled
Details
Run Pytest on Pull Request / test (push) Has been cancelled
Details
docker-build / build (push) Has been cancelled
Details
docker-build / merge (push) Has been cancelled
Details
Close stale pull requests/issues / Find Stale issues and PRs (push) Has been cancelled
Details
chore: improve doc generation and test (#762) 
Improve documentation generation and add tests for documentation.
Extend sphinx by todo directive.

The configuration table is now split into several tables. The test
is adapted accordingly.

There is a new test that checks the docstrings to be compliant to the
RST format as used by sphinx to create the documentation. We can not
use Markdown in docstrings. The docstrings are adapted accordingly.

An additional test checks that the documentation can be build with sphinx.
This test takes very long is only enabled in full run (aka. ci) mode.

Signed-off-by: Bobby Noelte <b0661n0e17e@gmail.com>
2025-11-13 22:53:46 +01:00

3.1 KiB
Raw Blame History

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.
provider EOS_ELECPRICE__PROVIDER Optional[str] rw None Electricity price provider id of provider to be used.
provider_settings EOS_ELECPRICE__PROVIDER_SETTINGS ElecPriceCommonProviderSettings rw required Provider settings
vat_rate EOS_ELECPRICE__VAT_RATE Optional[float] rw 1.19 VAT rate factor applied to electricity price when charges are used.
:::

Example Input/Output

   {
       "elecprice": {
           "provider": "ElecPriceAkkudoktor",
           "charges_kwh": 0.21,
           "vat_rate": 1.19,
           "provider_settings": {
               "ElecPriceImport": null
           }
       }
   }

Common settings for elecprice data import from file or JSON String

:::{table} elecprice::provider_settings::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": {
           "provider_settings": {
               "ElecPriceImport": {
                   "import_file_path": null,
                   "import_json": "{\"elecprice_marketprice_wh\": [0.0003384, 0.0003318, 0.0003284]}"
               }
           }
       }
   }

Electricity Price Prediction Provider Configuration

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

Name Type Read-Only Default Description
ElecPriceImport Optional[akkudoktoreos.prediction.elecpriceimport.ElecPriceImportCommonSettings] rw None ElecPriceImport settings
:::

Example Input/Output

   {
       "elecprice": {
           "provider_settings": {
               "ElecPriceImport": null
           }
       }
   }