Skip to main content

Load publicly available electric load forecasting datasets as pandas DataFrames.

Project description

A simle logo

padelf

Easy Pandas DataFrame-Access to publicly available electric load forecasting datasets

PyPI version Python License: MIT

padelf provides a minimal Python API to download, cache, and standardize electric load forecasting datasets for research. Every dataset is returned as a pandas DataFrame with a UTC DateTimeIndex and a standardized consumption_kW column.

Installation

pip install padelf

Quick Start

import padelf

# See what's available
padelf.list_datasets()
# ['AEMO', 'ENTSO-E', 'GEFCOM12', 'IHPC', 'ISO-NE', 'NYISO', 'OPSD', 'Pecan-Street', 'RTE-France']

# Load a dataset — one line, sensible defaults
df = padelf.get_dataset("OPSD")
print(df.head())

Output:

                                                     consumption_kW  DE_solar_generation_actual  DE_wind_onshore_generation_actual
datetime
2015-01-01 00:00:00+00:00       41209.0                        NaN                            7568.0
2015-01-01 01:00:00+00:00       40029.0                        NaN                            7666.0
2015-01-01 02:00:00+00:00       38891.0                        NaN                            7637.0

What You Get

Every call to get_dataset() returns a DataFrame with:

  • DateTimeIndex — UTC timezone, equidistant at the dataset's native resolution
  • consumption_kW — Load/consumption column, unit-converted to kilowatts
  • Additional columns — As available in the original dataset (e.g., temperature, solar generation)

Optional Parameters

df = padelf.get_dataset(
        "OPSD",
        resolution="15min",       # Resample to 15-minute intervals
        consumption_unit="MW",    # Keep original MW units
        interpolate_limit="4h",   # Fill gaps up to 4 hours
        cache_dir="/tmp/padelf",  # Custom cache location
)

Available Datasets

Dataset Abbreviation Resolution Region Status
Open Power System Data OPSD 60 min Europe Ready
Individual Household Power Consumption IHPC 1 min France Ready
GEFCom 2012 GEFCOM12 60 min US Ready*
ENTSO-E Transparency ENTSO-E 60 min Europe Planned
ISO New England ISO-NE 60 min US Planned
NYISO NYISO 5 min US Planned
AEMO AEMO 60 min Australia Planned
RTE France RTE-France 30 min France Planned
Pecan Street Pecan Street 15 min US Planned

* GEFCOM12: Dropbox source may be intermittently unavailable.

Documentation

Full documentation: https://lsb-dev.github.io/padelf-pip/

Original Catalog

A simle logo

To explore more datasets, check out the original PADELF Repository.

Citation

If you use padelf in your research, please cite the underlying dataset catalog:

@inproceedings{baur2024datasets,
    title     = {Publicly Available Datasets For Electric Load Forecasting -- An Overview},
    author    = {Baur, Lukas and Chandramouli, Vignesh and Sauer, Alexander},
    booktitle = {6th Conference on Production Systems and Logistics (CPSL 2024)},
    year      = {2024},
    doi       = {10.15488/17659}
}

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

padelf-0.1.0.tar.gz (25.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

padelf-0.1.0-py3-none-any.whl (14.6 kB view details)

Uploaded Python 3

File details

Details for the file padelf-0.1.0.tar.gz.

File metadata

  • Download URL: padelf-0.1.0.tar.gz
  • Upload date:
  • Size: 25.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.9

File hashes

Hashes for padelf-0.1.0.tar.gz
Algorithm Hash digest
SHA256 84e68a6ea15c6d1f476d8d38db3b36bbed0b68f3f2ab9aec76fe722e58ab59e3
MD5 f5ef4a9b1d5768ceb28277f8e274e43f
BLAKE2b-256 4099b91d934f72277ef924bac57967a0cd68b3dccfc23da72b397e11bc2ca7f0

See more details on using hashes here.

File details

Details for the file padelf-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: padelf-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 14.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.9

File hashes

Hashes for padelf-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 43b9811e1b0460d271b98828d4297f0c5039532f6aaab39234927c5048e24f0f
MD5 bea8f1b8f499f6e59d3e1defed8db928
BLAKE2b-256 9a696463c35033211e2ff608c1daacb66b130cc3e889ada62de4b803c14d6e7f

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page