Energy Price Forecasting Toolbox 2
Project description
epftoolbox2
A modern Python library for electricity price forecasting with modular data pipelines and model evaluation. Built as a complete rewrite of the original epftoolbox, this library provides a flexible, extensible framework for downloading energy market data, building forecasting models, and evaluating their performance.
Installation
pip install epftoolbox2
or with uv
uv add epftoolbox2
Key Features
- Data Sources: ENTSOE (load, generation, prices), Open-Meteo (weather forecasts), Calendar (holidays, weekday)
- Transformers: Resample, Timezone conversion, Lag features
- Validators: Null checks, Continuity checks, EDA statistics
- Models: OLS, LassoCV
- Evaluators: MAE
- Exporters: Excel with conditional formatting, Terminal output
- Caching: Built-in data caching to avoid redundant API calls
- Pipelines: Data and model pipelines that can be saved and loaded with .yaml files
- Multithreading: Multithreading with free GIL support in python 3.13t and above
- Extensibility: Extensible base classes for data sources, transformers, validators, models, evaluators, and exporters
Quick Start
Standalone source use
from epftoolbox2.data.sources import EntsoeSource
source = EntsoeSource("PL", api_key="YOUR_KEY", type=["load", "price"])
df = source.run("2024-01-01", "2024-06-01", cache=True)
Standalone transformer use
from epftoolbox2.data.transformers import ResampleTransformer
transformer = ResampleTransformer(freq="1h")
df = transformer.run(df)
Standalone validator use
from epftoolbox2.data.validators import NullCheckValidator
validator = NullCheckValidator(columns=["load_actual", "price"])
df = validator.run(df)
Standalone model use
from epftoolbox2.models import OLSModel
model = OLSModel(predictors=["load_actual", "weekday"], name="OLS")
report = model.run(df, test_start="2024-04-01", test_end="2024-06-01", target="price")
Standalone evaluator use
from epftoolbox2.evaluators import MAEEvaluator
evaluator = MAEEvaluator()
report = evaluator.run(df, test_start="2024-04-01", test_end="2024-06-01", target="price")
Standalone exporter use
from epftoolbox2.exporters import ExcelExporter
exporter = ExcelExporter("results.xlsx")
report = exporter.run(df, test_start="2024-04-01", test_end="2024-06-01", target="price")
Data Pipeline
Download and process electricity market data from ENTSOE, weather forecasts from Open-Meteo, and calendar features.
from epftoolbox2.pipelines import DataPipeline
from epftoolbox2.data.sources import EntsoeSource, OpenMeteoSource, CalendarSource
from epftoolbox2.data.transformers import ResampleTransformer
from epftoolbox2.data.validators import NullCheckValidator
pipeline = (
DataPipeline()
.add_source(EntsoeSource("PL", api_key="YOUR_KEY", type=["load", "price"]))
.add_source(OpenMeteoSource(latitude=52.23, longitude=21.01))
.add_source(CalendarSource("PL", holidays="binary", weekday="number"))
.add_transformer(ResampleTransformer(freq="1h"))
.add_validator(NullCheckValidator(columns=["load_actual", "price"]))
)
df = pipeline.run("2024-01-01", "2024-06-01", cache=True)
Model Pipeline
Train and evaluate forecasting models with built-in metrics and export capabilities.
from epftoolbox2.pipelines import ModelPipeline
from epftoolbox2.models import OLSModel, LassoCVModel
from epftoolbox2.evaluators import MAEEvaluator
from epftoolbox2.exporters import ExcelExporter
pipeline = (
ModelPipeline()
.add_model(OLSModel(predictors=["load_actual", "weekday"], name="OLS"))
.add_model(LassoCVModel(predictors=["load_actual", "weekday"], name="Lasso"))
.add_evaluator(MAEEvaluator())
.add_exporter(ExcelExporter("results.xlsx"))
)
report = pipeline.run(df, test_start="2024-04-01", test_end="2024-06-01", target="price")
Examples
See the examples/ folder for complete working examples.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file epftoolbox2-2.0.0a1.tar.gz.
File metadata
- Download URL: epftoolbox2-2.0.0a1.tar.gz
- Upload date:
- Size: 293.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.14.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f9a034d283cc938e503a7fd9f55fe8b40480cfb56ff9a0d5e658489ceb3b9440
|
|
| MD5 |
ebdaff369326bc71a0abee4c4ffb0337
|
|
| BLAKE2b-256 |
b12d17db68b2987094780b93b40d06fb67c3189fbd974cdc5951ffa04916ba5b
|
File details
Details for the file epftoolbox2-2.0.0a1-py3-none-any.whl.
File metadata
- Download URL: epftoolbox2-2.0.0a1-py3-none-any.whl
- Upload date:
- Size: 50.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.14.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
eaacdfed731750312af234106f6c9dabc0f9d35870b7ccc83d9a9927cbf04dd4
|
|
| MD5 |
32cd100b4a59b4f5e4352d80b27b3230
|
|
| BLAKE2b-256 |
a7d4ca58acfcf528aa459260d2c693fb103a3f88af55fa7bb5b5da28a78e3d9d
|