Welcome to demod’s documentation!

Demod is a Python library for assembling bottom-up domestic energy demand models.

Features

• Easy-to-use load profile generation

• API for creating your own simulations

• Datasets support

• Flexible framework

• Free and Open source

Contents:

• Overview
  • What’s demod supposed to do?
  • Socio-technical modeling
  • Examples of application
  • demod’s main components
• Quickstart
  • Running a Simulation
  • Without Python Scripting
• Installation
  • Requirements
  • Install with pip
  • Install from source
• API Reference
  • Simulators
  • Abstract simulators
  • Datasets
  • Metrics
  • Utility Classes and Functions
  • Appliances Support
  • Socio-Technical helper functions
  • Cards documentation
  • Testing API
• Tutorials
  • Creating your first simulator
  • Create a Time Aware Simulator
  • Multi Simulator
  • Datasets
  • Testing
  • Integration with Co-simulation Frameworks
• Examples
  • Quickstart Examples
• Contributing
  • Coding guidelines
  • Documenting your code
  • Citing
  • Licence
  • Integrating your code to GitHub
• About Demod
  • Fundings
  • License
• Glossary
• References

Contribute

• Source Code: https://github.com/epfl-herus/demod

Support

If you are having issues, please let us know. We have a mailing list located at: demod@groupes.epfl.ch

License

Demod is published under a GPLv3 Licence .