Skip to main content
EnergyFaultDetector Logo

Energy Fault Detector - Autoencoder-based Fault Detection for the Future Energy System

Python PyPI version License: MIT Tests Documentation

Energy Fault Detector is an open-source Python package for automated anomaly detection in operational data from renewable energy systems and power grids. It uses autoencoder-based normal-behaviour models to identify irregularities and includes the ARCANA method for interpretable root cause analysis.

drawing

Features (at a glance)

  • User-friendly interface: One-command CLI (quick_fault_detector) demo and a simple Python API.
  • Built-in data preprocessing (clipping, imputation, counter→rate, angle transforms, etc.)
  • Fault Detection: Autoencoder-based normal behaviour modelling for time series and tabular data.
  • Root Cause Analysis: Pinpoints the specific sensor values responsible for detected anomalies using ARCANA.
  • Scalability: Algorithms can easily be adapted to various datasets and trained models can be transferred to and fine-tuned on similar datasets. Quickly evaluate many different model configurations
  • Support for benchmark datasets (CARE2Compare, PreDist) and CARE-Score evaluation

See the online documentation for concepts, model types, and configuration details.

Installation

pip install energy-fault-detector

Requirements: Python 3.10–3.12, TensorFlow ≥ 2.15

For development (tests, linting):

pip install energy-fault-detector[dev]

Quickstart

import pandas as pd
from energy_fault_detector import FaultDetector, Config
from energy_fault_detector.config import generate_quickstart_config

### 1. Load your data
df = pd.read_csv("my_data.csv", parse_dates=["timestamp"], index_col="timestamp")
sensor_data = df[["power", "wind_speed", "pitch"]]
normal_index = df["status"] == "normal"  # optional boolean mask

### 2. Generate a default configuration
config = generate_quickstart_config()

### 3. Train a normal-behaviour model
fault_detector = FaultDetector(config=config, model_directory="my_model")
fault_detector.fit(sensor_data=sensor_data, normal_index=normal_index)

### 4. Predict anomalies
results = fault_detector.predict(sensor_data=sensor_data)

print(results.predicted_anomalies.sum(), "anomalies detected")

More examples: Usage examples.

Quick Fault Detection (CLI)

Run the full pipeline (train → predict → events → ARCANA) in a single command:

quick_fault_detector path/to/data.csv

For CARE2Compare data:

quick_fault_detector path/to/c2c_dataset.csv --c2c_example

The CLI saves plots and CSV results to a results directory. See the CLI documentation for details.

Documentation

Full docs (concepts, available models, configuration reference, evaluation, and examples): https://aefdi.github.io/EnergyFaultDetector/

Examples and notebooks

The repository contains Jupyter notebooks with end-to-end examples and evaluation workflows in the notebooks/ folder, for example:

  • Quick fault detection on a CSV file
  • Standard FaultDetector training and prediction
  • Sequence models (LSTM/CNN) on time-series data
  • CARE2Compare and PreDist benchmark evaluations

These notebooks complement the documentation and are a good starting point for interactive exploration.

Contributing

Contributions are welcome! Please feel free to open issues or submit pull requests. All contributions, bug reports, bug fixes, documentation improvements, enhancements, and ideas are welcome. Please see CONTRIBUTING.md for guidelines on how to contribute.

Planned updates and features

  • Demo: Easy demo website
  • Extending the core models:
    • Variational autoencoders
    • Model ensembles
  • Unification, standardisation and generic improvements
    • Data preparation (e.g. extend imputation strategies).
    • No or low configuration need (e.g. use defaults where possible).
    • Upgrade to Keras 3.0
  • Root cause analysis expansion
    • integrate SHAP and possibly other xAI-methods.
  • Integrations
    • logging/tracking to MLFlow for hyperparameter tuning and easy model deployment.
    • Edge deployment

License

This project is licensed under the MIT License.

Background

This project was initially developed by the research team AEFDI at the Fraunhofer IEE in the research project ADWENTURE (funded by the German Federal Ministry for Economic Affairs and Climate Action (BMWK)), to create a software for early fault detection in wind turbines. The software was developed in such a way that the algorithms do not depend on a specific data source and can be applied to other use cases as well.

References

If you use this work, please cite us:

Fault detection in district heating substations:

ARCANA Algorithm: Autoencoder-based anomaly root cause analysis for wind turbines. Energy and AI. 2021;4:100065. https://doi.org/10.1016/j.egyai.2021.100065

CARE to Compare dataset and CARE-Score:

Transfer learning methods: Transfer learning applications for autoencoder-based anomaly detection in wind turbines. Energy and AI. 2024;17:100373. https://doi.org/10.1016/j.egyai.2024.100373

Autoencoder-based anomaly detection: Evaluation of Anomaly Detection of an Autoencoder Based on Maintenance Information and Scada-Data. Energies. 2020; 13(5):1063., https://doi.org/10.3390/en13051063.

Contact

For questions, feedback, or support integrating the EnergyFaultDetector into your operations, please contact aefdi@iee.fraunhofer.de.

Metadata

Release files for energy-fault-detector 0.7.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for energy-fault-detector 0.7.1
File Size Uploaded Provenance
energy_fault_detector-0.7.1.tar.gz 369.6 kB With provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for energy-fault-detector 0.7.1
File Interpreter ABI Platform
energy_fault_detector-0.7.1-py3-none-any.whl Python 3 none any Details

Total release size: 547.9 kB

Release files / energy_fault_detector-0.7.1.tar.gz

Download URL energy_fault_detector-0.7.1.tar.gz
Size 369.6 kB
Tags Source
SHA-256 checksum
How to use checksums
b44f36c4ecbc7e4a95319b8324f1fda13ad3e3d2052ee73ea6e9a977ef96dec9
BLAKE2b-256 checksum
How to use checksums
e969e41e5ece29f8a261aee25a8d64005a441466a8d2b42254bbba2c76aeb6f0
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 15, 2026.

Transparency log

Release files / energy_fault_detector-0.7.1-py3-none-any.whl

Download URL energy_fault_detector-0.7.1-py3-none-any.whl
Size 178.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
e9cdbe2c2d4637de5aa58af4654a274e6ee59ca0c52ec2dce6c30cf6d346ce4a
BLAKE2b-256 checksum
How to use checksums
5ab878b1d48ffaa61a99066e6d7ca3cd0f826d07a840ccc7d9fb2b48b4a876b9
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 15, 2026.

Transparency log

Security for energy-fault-detector 0.7.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

All 2 files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for energy_fault_detector-0.7.1.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 15, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page