Repository files navigation

EnergyFaultDetector Logo

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

PythonPyPI versionLicense: MITTestsDocumentation

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

importpandasaspdfromenergy_fault_detectorimportFaultDetector, Configfromenergy_fault_detector.configimportgenerate_quickstart_config### 1. Load your datadf=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 configurationconfig=generate_quickstart_config()
### 3. Train a normal-behaviour modelfault_detector=FaultDetector(config=config, model_directory="my_model")
fault_detector.fit(sensor_data=sensor_data, normal_index=normal_index)
### 4. Predict anomaliesresults=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.

About

Interpretable Autoencoder-based Fault Detection for the Energy System

Resources

Contributing

Stars

45 stars

Watchers

4 watching

Forks

Releases

Packages

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content

Repository files navigation

EnergyFaultDetector Logo

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

PythonPyPI versionLicense: MITTestsDocumentation

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

importpandasaspdfromenergy_fault_detectorimportFaultDetector, Configfromenergy_fault_detector.configimportgenerate_quickstart_config### 1. Load your datadf=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 configurationconfig=generate_quickstart_config()
### 3. Train a normal-behaviour modelfault_detector=FaultDetector(config=config, model_directory="my_model")
fault_detector.fit(sensor_data=sensor_data, normal_index=normal_index)
### 4. Predict anomaliesresults=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.

About

Interpretable Autoencoder-based Fault Detection for the Energy System

Resources

Contributing

Stars

45 stars

Watchers

4 watching

Forks

Releases

Packages

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Repository files navigation

EnergyFaultDetector Logo

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

PythonPyPI versionLicense: MITTestsDocumentation

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

importpandasaspdfromenergy_fault_detectorimportFaultDetector, Configfromenergy_fault_detector.configimportgenerate_quickstart_config### 1. Load your datadf=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 configurationconfig=generate_quickstart_config()
### 3. Train a normal-behaviour modelfault_detector=FaultDetector(config=config, model_directory="my_model")
fault_detector.fit(sensor_data=sensor_data, normal_index=normal_index)
### 4. Predict anomaliesresults=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.

About

Interpretable Autoencoder-based Fault Detection for the Energy System

Resources

Contributing

Stars

45 stars

Watchers

4 watching

Forks

Releases

Packages

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Repository files navigation

EnergyFaultDetector Logo

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

PythonPyPI versionLicense: MITTestsDocumentation

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

importpandasaspdfromenergy_fault_detectorimportFaultDetector, Configfromenergy_fault_detector.configimportgenerate_quickstart_config### 1. Load your datadf=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 configurationconfig=generate_quickstart_config()
### 3. Train a normal-behaviour modelfault_detector=FaultDetector(config=config, model_directory="my_model")
fault_detector.fit(sensor_data=sensor_data, normal_index=normal_index)
### 4. Predict anomaliesresults=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.

About

Interpretable Autoencoder-based Fault Detection for the Energy System

Resources

Contributing

Stars

45 stars

Watchers

4 watching

Forks

Releases

Packages

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content

Repository files navigation

EnergyFaultDetector Logo

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

PythonPyPI versionLicense: MITTestsDocumentation

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

importpandasaspdfromenergy_fault_detectorimportFaultDetector, Configfromenergy_fault_detector.configimportgenerate_quickstart_config### 1. Load your datadf=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 configurationconfig=generate_quickstart_config()
### 3. Train a normal-behaviour modelfault_detector=FaultDetector(config=config, model_directory="my_model")
fault_detector.fit(sensor_data=sensor_data, normal_index=normal_index)
### 4. Predict anomaliesresults=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.

About

Interpretable Autoencoder-based Fault Detection for the Energy System

Resources

Contributing

Stars

45 stars

Watchers

4 watching

Forks

Releases

Packages

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Repository files navigation

EnergyFaultDetector Logo

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

PythonPyPI versionLicense: MITTestsDocumentation

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

importpandasaspdfromenergy_fault_detectorimportFaultDetector, Configfromenergy_fault_detector.configimportgenerate_quickstart_config### 1. Load your datadf=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 configurationconfig=generate_quickstart_config()
### 3. Train a normal-behaviour modelfault_detector=FaultDetector(config=config, model_directory="my_model")
fault_detector.fit(sensor_data=sensor_data, normal_index=normal_index)
### 4. Predict anomaliesresults=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.

About

Interpretable Autoencoder-based Fault Detection for the Energy System

Resources

Contributing

Stars

45 stars

Watchers

4 watching

Forks

Releases

Packages

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Repository files navigation

EnergyFaultDetector Logo

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

PythonPyPI versionLicense: MITTestsDocumentation

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

importpandasaspdfromenergy_fault_detectorimportFaultDetector, Configfromenergy_fault_detector.configimportgenerate_quickstart_config### 1. Load your datadf=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 configurationconfig=generate_quickstart_config()
### 3. Train a normal-behaviour modelfault_detector=FaultDetector(config=config, model_directory="my_model")
fault_detector.fit(sensor_data=sensor_data, normal_index=normal_index)
### 4. Predict anomaliesresults=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.

About

Interpretable Autoencoder-based Fault Detection for the Energy System

Resources

Contributing

Stars

45 stars

Watchers

4 watching

Forks

Releases

Packages

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content

Repository files navigation

EnergyFaultDetector Logo

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

PythonPyPI versionLicense: MITTestsDocumentation

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

importpandasaspdfromenergy_fault_detectorimportFaultDetector, Configfromenergy_fault_detector.configimportgenerate_quickstart_config### 1. Load your datadf=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 configurationconfig=generate_quickstart_config()
### 3. Train a normal-behaviour modelfault_detector=FaultDetector(config=config, model_directory="my_model")
fault_detector.fit(sensor_data=sensor_data, normal_index=normal_index)
### 4. Predict anomaliesresults=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.

About

Interpretable Autoencoder-based Fault Detection for the Energy System

Resources

Contributing

Stars

45 stars

Watchers

4 watching

Forks

Releases

Packages

Contributors

Languages