ASSUME
An open-source toolbox for agent-based simulations of European electricity markets, with a primary focus on the German market setup.
https://github.com/assume-framework/assume
Category: Energy Systems
Sub Category: Energy Markets
Last synced: about 7 hours ago
JSON representation
Repository metadata
ASSUME - Agent-based Simulation for Studying and Understanding Market Evolution
- Host: GitHub
- URL: https://github.com/assume-framework/assume
- Owner: assume-framework
- License: agpl-3.0
- Created: 2023-04-19T09:20:48.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-12-16T17:16:19.000Z (9 days ago)
- Last Synced: 2025-12-17T04:13:06.983Z (9 days ago)
- Language: Python
- Homepage: https://assume.readthedocs.io
- Size: 794 MB
- Stars: 70
- Watchers: 3
- Forks: 30
- Open Issues: 27
- Releases: 18
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
- Codemeta: codemeta.json
README.md
ASSUME: Agent-Based Electricity Markets Simulation Toolbox
ASSUME is an open-source toolbox for agent-based simulations of European electricity markets, with a primary focus on the German market setup.
Developed as an open-source model, its primary objectives are to ensure usability and customizability for a wide range of users and use cases in the energy system modeling community.
Introduction
A unique feature of the ASSUME toolbox is its integration of Deep Reinforcement Learning methods into the behavioral strategies of market agents. The model offers various predefined agent representations for both the demand and generation sides, which can be used as plug-and-play modules, simplifying the reinforcement of learning strategies.
This setup enables research into new market designs and dynamics in energy markets.
What can the software do?
The main motivation of ASSUME is to overcome the limitations of fixed, rule-based behaviors in existing ABMs.
For this, it leverages advancements in artificial intelligence, particularly deep reinforcement learning (DRL), enabling agents to adapt their behavior dynamically in response to market conditions.
This approach is practical for modeling interactions among competing market participants and observing emergent patterns from these interactions.
To support market design analysis in transforming electricity systems, we developed the ASSUME framework - a flexible and modular agent-based modeling tool for electricity market research.
ASSUME enables researchers to customize components such as agent representations, market configurations, and bidding strategies, utilizing pre-built modules for standard operations.
With the setup in ASSUME, researchers can simulate strategic interactions in electricity markets under a wide range of scenarios, from comparing market designs and modeling congestion management to analyzing the behavior of learning storage operators and renewable producers.
The framework supports studies on bidding under uncertainty, regulatory interventions, and multi-agent dynamics, making it ideal for exploring emergent behavior and testing new market mechanisms.
ASSUME has been utilized in research studies addressing diverse questions in electricity market design and operation.
It has explored the role of complex bids, demonstrated the effects of industrial demand-side flexibility for congestion management, and advanced the explainability of emergent strategies in learning agents.
Who is it made for?
The framework is versatile enough to be employed in smaller-scale projects, such as master's theses, while also robust enough for complex doctoral research or investigations conducted by industry professionals.
This accessibility and scalability make ASSUME suitable for many users, from early-career researchers to experienced professionals.
Documentation
Installation
You can install ASSUME using pip.
Choose the appropriate installation method based on your needs:
Using pip
To install the core package:
pip install assume-framework
To install with reinforcement learning capabilities:
pip install 'assume-framework[learning]'
Please keep in mind, that the above installation method will install pytorch package without CUDA support.
If you want to make use of your GPU with CUDA cores, please install pytorch with GPU support separately as described here.
We also include network-based market clearing algorithms such as for the re-dispatch or nodal market clearing, which requires the PyPSA library.
To install the package with these capabilities, use:
pip install 'assume-framework[network]'
To install with all capabilities:
pip install 'assume-framework[all]'
Timescale Database and Grafana Dashboards
If you want to benefit from a supported database and integrated Grafana dashboards for scenario analysis, you can use the provided Docker Compose file.
Follow these steps:
- Clone the repository and navigate to its directory:
git clone https://github.com/assume-framework/assume.git
cd assume
- Start the database and Grafana using the following command:
docker compose up -d
This will launch a container for TimescaleDB and Grafana with preconfigured dashboards for analysis.
You can access the Grafana dashboards at http://localhost:3000.
Using TensorBoard to display Learning Metrics
When running an example with learning capabilities, you can start TensorBoard to observe the learning process.
Use the following shell command to start TensorBoard:
tensorboard --logdir tensorboard
You can then head to http://localhost:6006/ to view and evaluate the training progress.
Please note that TensorBoard should ideally be shut down via Ctrl + C every time you want to start a new simulation run in the same folder structure and want to overwrite existing results, as failing to do so may lead to conflicts deleting old logs.
Trying out ASSUME and the provided Examples
To ease your way into ASSUME we provided some examples and tutorials.
The former are helpful if you would like to get an impression of how ASSUME works and the latter introduce you into the development of ASSUME.
The Tutorials
The tutorials work completely detached from your own machine on google colab.
They provide code snippets and task that show you, how you can work with the software package one your own.
We have multiple tutorials prepared, e.g. one for introducing a new unit and three for getting reinforcement learning ready on ASSUME.
How to configure a new unit in ASSUME?
How to change and adapt reinforcement learning algorithms in ASSUME?
How to use reinforcement learning for new market participants in ASSUME?
The Examples
To explore the provided examples, follow these steps:
- Clone the repository and navigate to its directory:
git clone https://github.com/assume-framework/assume.git
cd assume
- Quick Start:
There are three ways to run a simulation:
- Local:
python examples/examples.py
- Using the provided Docker setup:
If you have installed Docker and set up the Docker Compose file previously, you can select 'timescale' in examples.py before running the simulation.
This will save the simulation results in a Timescale database, and you can access the Dashboard at http://localhost:3000.
- Using the CLI to run simulations:
assume -s example_01b -db "postgresql://assume:assume@localhost:5432/assume"
For additional CLI options, run assume -h.
Development
Creating Documentation
See the Contribution Guidelines on how to build the docs for ASSUME.
Contributors and Funding
The project is developed by a collaborative team of researchers from INATECH at the University of Freiburg, IISM at Karlsruhe Institute of Technology, Fraunhofer Institute for Systems and Innovation Research, Fraunhofer Institution for Energy Infrastructures and Geothermal Energy, and FH Aachen - University of Applied Sciences. Each contributor brings valuable expertise in electricity market modeling, deep reinforcement learning, demand side flexibility, and infrastructure modeling.
ASSUME is funded by the Federal Ministry for Economic Affairs and Climate Action (BMWK).
We are grateful for their support in making this project possible.
Citing ASSUME
If you use ASSUME in your research, we would appreciate it if you cite the following paper:
- Nick Harder, Kim K. Miskiw, Manish Khanra, Florian Maurer, Parag Patil, Ramiz Qussous, Christof Weinhardt, Marian Klobasa, Mario Ragwitz, Anke Weidlich,
ASSUME: An agent-based simulation framework for exploring electricity market dynamics with reinforcement learning, published in SoftwareX, Volume 30, 2025, Article 102176.
Please use the following BibTeX to cite our work:
@article{ASSUME,
title = {{ASSUME: An agent-based simulation framework for exploring electricity market dynamics with reinforcement learning}},
author = {Harder, Nick and Miskiw, Kim K and Khanra, Manish and Maurer, Florian and Patil, Parag and Qussous, Ramiz and Weinhardt, Christof and Klobasa, Marian and Ragwitz, Mario and Weidlich, Anke},
journal = {SoftwareX},
volume = {30},
pages = {102176},
year = {2025},
issn = {2352-7110},
doi = {10.1016/j.softx.2025.102176},
url = {https://www.sciencedirect.com/science/article/pii/S2352711025001438},
keywords = {Electricity markets, Python, Reinforcement learning, Agent-based modeling}
}
If you want to cite a specific version of ASSUME, all releases are archived on Zenodo with version-specific DOIs:
License
Copyright 2022-2025 ASSUME developers.
ASSUME is licensed under the GNU Affero General Public License v3.0. This license is a strong copyleft license that requires that any derivative work be licensed under the same terms as the original work. It is approved by the Open Source Initiative.
Owner metadata
- Name: assume-framework
- Login: assume-framework
- Email:
- Kind: organization
- Description:
- Website:
- Location:
- Twitter:
- Company:
- Icon url: https://avatars.githubusercontent.com/u/131251735?v=4
- Repositories: 1
- Last ynced at: 2023-04-24T16:04:10.545Z
- Profile URL: https://github.com/assume-framework
GitHub Events
Total
- Create event: 155
- Release event: 8
- Issues event: 98
- Watch event: 29
- Delete event: 153
- Member event: 5
- Issue comment event: 344
- Push event: 1283
- Pull request review event: 444
- Pull request review comment event: 330
- Pull request event: 224
- Fork event: 19
Last Year
- Create event: 153
- Release event: 8
- Issues event: 96
- Watch event: 29
- Delete event: 152
- Member event: 5
- Issue comment event: 340
- Push event: 1276
- Pull request event: 224
- Pull request review event: 444
- Pull request review comment event: 329
- Fork event: 19
Committers metadata
Last synced: 1 day ago
Total Commits: 1,132
Total Committers: 23
Avg Commits per committer: 49.217
Development Distribution Score (DDS): 0.677
Commits in past year: 334
Committers in past year: 15
Avg Commits per committer in past year: 22.267
Development Distribution Score (DDS) in past year: 0.707
| Name | Commits | |
|---|---|---|
| Florian Maurer | m****r@f****e | 366 |
| Nick Harder | n****4@g****m | 333 |
| kim-mskw | k****w@k****u | 207 |
| Andreas Eppler | A****7@w****e | 56 |
| Johanna Adams | j****s@t****e | 47 |
| mthede | m****n@k****u | 34 |
| Jannik | r****b@f****e | 22 |
| gugrimm | 1****m | 15 |
| Johanna Adams | a****j@t****e | 13 |
| Manish Khanra | 4****a | 12 |
| Philipp Fritz | f****p@o****e | 5 |
| unknown | a****o@w****e | 5 |
| tiernan-buckley-ufr | t****2@s****e | 4 |
| Finn Reinecke | 9****i | 2 |
| Nick Marx | n****x@s****u | 2 |
| Michael Hafner | 1****l | 2 |
| Carl Wanninger | 9****i | 1 |
| DominikBurkert | 3****t | 1 |
| Hendrik Wulfert | H****t@i****e | 1 |
| Kyle Niemeyer | k****r@f****m | 1 |
| Ramiz Qussous | r****s | 1 |
| Robbe Sneyders | r****s@g****m | 1 |
| chiara-fb | c****i@g****m | 1 |
Committer domains:
- tf.uni-freiburg.de: 2
- kit.edu: 2
- fh-aachen.de: 2
- fastmail.com: 1
- inatech.uni-freiburg.de: 1
- student.kit.edu: 1
- students.uni-freiburg.de: 1
- outlook.de: 1
Issue and Pull Request metadata
Last synced: 7 days ago
Total issues: 143
Total pull requests: 625
Average time to close issues: 3 months
Average time to close pull requests: 6 days
Total issue authors: 23
Total pull request authors: 20
Average comments per issue: 1.5
Average comments per pull request: 1.76
Merged pull request: 487
Bot issues: 0
Bot pull requests: 0
Past year issues: 34
Past year pull requests: 178
Past year average time to close issues: 26 days
Past year average time to close pull requests: 7 days
Past year issue authors: 14
Past year pull request authors: 16
Past year average comments per issue: 1.26
Past year average comments per pull request: 1.95
Past year merged pull request: 122
Past year bot issues: 0
Past year bot pull requests: 0
Top Issue Authors
- nick-harder (43)
- kim-mskw (29)
- maurerle (23)
- adamsjohanna (10)
- dlr-cjs (6)
- mthede (5)
- AndreasEppler (4)
- paragpatil39 (3)
- Manish-Khanra (3)
- jrasko (2)
- matthieusirius (2)
- HafnerMichael (2)
- s-gryt (1)
- tomissg (1)
- fritzphilipp (1)
Top Pull Request Authors
- maurerle (227)
- nick-harder (209)
- kim-mskw (73)
- Manish-Khanra (21)
- adamsjohanna (21)
- mthede (12)
- HafnerMichael (9)
- jrasko (9)
- AndreasEppler (8)
- tiernan-buckley-ufr (8)
- paragpatil39 (7)
- Graf-Wronski (4)
- fritzphilipp (4)
- gugrimm (3)
- ChriKo97 (2)
Top Issue Labels
- documentation (12)
- enhancement (11)
- feature (10)
- bug (9)
- validation (6)
- tests (4)
- question (3)
- examples (3)
- priority: low (3)
- Workshop Prep (2)
- priority: high (2)
- discussion needed (2)
- upstream-fix-required (1)
- invalid (1)
Top Pull Request Labels
- feature (5)
- priority: high (5)
- enhancement (4)
- discussion needed (3)
- documentation (2)
- priority: low (2)
- bug (2)
- examples (1)
- blocked (1)
Package metadata
- Total packages: 2
-
Total downloads:
- pypi: 260 last-month
- Total dependent packages: 0 (may contain duplicates)
- Total dependent repositories: 0 (may contain duplicates)
- Total versions: 36
- Total maintainers: 2
proxy.golang.org: github.com/assume-framework/assume
- Homepage:
- Documentation: https://pkg.go.dev/github.com/assume-framework/assume#section-documentation
- Licenses: agpl-3.0
- Latest release: v0.5.5 (published 4 months ago)
- Last Synced: 2025-12-22T14:06:47.464Z (3 days ago)
- Versions: 16
- Dependent Packages: 0
- Dependent Repositories: 0
-
Rankings:
- Dependent packages count: 5.401%
- Average: 5.583%
- Dependent repos count: 5.764%
pypi.org: assume-framework
ASSUME - Agent-Based Electricity Markets Simulation Toolbox
- Homepage: https://assume-project.de/
- Documentation: https://assume.readthedocs.io
- Licenses: AGPL-3.0-or-later
- Latest release: 0.5.5 (published 4 months ago)
- Last Synced: 2025-12-22T14:06:46.221Z (3 days ago)
- Versions: 20
- Dependent Packages: 0
- Dependent Repositories: 0
- Downloads: 260 Last month
-
Rankings:
- Dependent packages count: 7.402%
- Stargazers count: 21.618%
- Forks count: 22.802%
- Average: 30.228%
- Dependent repos count: 69.09%
- Maintainers (2)
Dependencies
- actions/checkout v3 composite
- docker/build-push-action v4 composite
- docker/login-action v2.2.0 composite
- docker/metadata-action v4 composite
- docker/setup-buildx-action v2 composite
- actions/checkout v3 composite
- actions/setup-python v4 composite
- actions/upload-artifact v3 composite
- codecov/codecov-action v3 composite
- python 3.11-bookworm build
- black ^23.3.0
- glpk ^0.4.7
- isort ^5.12.0
- mango-agents ^1.1.1
- matplotlib ^3.7.2
- mypy ^1.1.1
- nest-asyncio ^1.5.6
- paho-mqtt ^1.5.1
- pandas ^2.0.0
- psycopg2-binary ^2.9.5
- pyomo ^6.6.1
- pytest ^7.2.2
- pytest-asyncio ^0.21.1
- pytest-cov ^4.1.0
- python ^3.10
- python-dateutil ^2.8.2
- pyyaml ^6.0
- sqlalchemy ^2.0.9
- torch ^2.0.1
- tqdm ^4.64.1
Score: 13.278549698193629