ASSUME - Agent-based Simulation for Studying and Understanding Market Evolution

ASSUME - Agent-based Simulation for Studying and Understanding Market Evolution - Published in JOSS (2025)

https://github.com/assume-framework/assume

Science Score: 95.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 8 DOI reference(s) in README and JOSS metadata
  • Academic publication links
    Links to: sciencedirect.com, joss.theoj.org, zenodo.org
  • Committers with academic emails
    7 of 16 committers (43.8%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
    Published in Journal of Open Source Software

Scientific Fields

Engineering Computer Science - 41% confidence
Last synced: 4 months ago · JSON representation

Repository

ASSUME - Agent-based Simulation for Studying and Understanding Market Evolution

Basic Info
  • Host: GitHub
  • Owner: assume-framework
  • License: agpl-3.0
  • Language: Python
  • Default Branch: main
  • Homepage: https://assume.readthedocs.io
  • Size: 471 MB
Statistics
  • Stars: 61
  • Watchers: 3
  • Forks: 21
  • Open Issues: 22
  • Releases: 18
Created over 2 years ago · Last pushed 4 months ago
Metadata Files
Readme Contributing License Code of conduct Codemeta

README.md

ASSUME: Agent-Based Electricity Markets Simulation Toolbox

Lint Status Code Coverage DOI REUSE status

DOI

Try examples in Colab

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 behaviour 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:

bash pip install assume-framework

To install with reinforcement learning capabilities:

bash 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:

bash pip install 'assume-framework[network]'

To install with all capabilities:

bash 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:

  1. Clone the repository and navigate to its directory:

bash git clone https://github.com/assume-framework/assume.git cd assume

  1. Start the database and Grafana using the following command:

bash 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: shell 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?

Open Learning Tutorial in Colab

How to change and adapt reinforcement learning algorithms in ASSUME?

Open Learning Tutorial in Colab

How to use reinforcement learning for new market participants in ASSUME?

  • Power plant unit: Open Learning Tutorial in Colab

  • Storage unit: Open Learning Tutorial in Colab

The Examples

To explore the provided examples, follow these steps:

  1. Clone the repository and navigate to its directory:

bash git clone https://github.com/assume-framework/assume.git cd assume

  1. Quick Start:

There are three ways to run a simulation:

  • Local:

bash 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:

bash assume -s example_01b -db "postgresql://assume:assume@localhost:5432/assume"

For additional CLI options, run assume -h.

Development

The Contribution Guidelines explain how to setup your development environment and contribute to the project.

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:

Please use the following BibTeX to cite our work:

bibtex @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:

DOI

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

  • Name: assume-framework
  • Login: assume-framework
  • Kind: organization

JOSS Publication

ASSUME - Agent-based Simulation for Studying and Understanding Market Evolution
Published
August 14, 2025
Volume 10, Issue 112, Page 8515
Authors
Florian Maurer ORCID
University of Applied Sciences Aachen, Germany
Nick Harder ORCID
Institute for Sustainable Systems Engineering, University of Freiburg, Freiburg, Germany
Kim K. Miskiw ORCID
Institute of Information Systems and Marketing, Karlsruhe Institute of Technology, Karlsruhe, Germany
Manish Khanra ORCID
Fraunhofer Institute for Systems and Innovation Research, Karlsruhe, Germany
Editor
Kyle Niemeyer ORCID
Tags
agent based modeling energy market reinforcement learning software simulation

CodeMeta (codemeta.json)

{
  "@context": "https://raw.githubusercontent.com/codemeta/codemeta/master/codemeta.jsonld",
  "@type": "Code",
  "author": [
    {
      "@id": "https://orcid.org/0000-0001-8345-3889",
      "@type": "Person",
      "email": "maurer@fh-aachen.de",
      "name": "Florian Maurer",
      "affiliation": "FH Aachen"
    },
    {
      "@id": "https://orcid.org/0000-0003-1897-3671",
      "@type": "Person",
      "email": "nick.harder@inatech.uni-freiburg.de",
      "name": "Nick Harder",
      "affiliation": "Universität Freiburg"
    },
    {
      "@id": "https://orcid.org/0009-0009-1389-4844",
      "@type": "Person",
      "email": "kim.miskiw@kit.edu",
      "name": "Kim K. Miskiw",
      "affiliation": "Karlsruhe Institute of Technology"
    },
    {
      "@id": "https://orcid.org/0000-0002-3347-9922",
      "@type": "Person",
      "email": "manish.khanra@isi.fraunhofer.de",
      "name": "Manish Khanra",
      "affiliation": "Fraunhofer ISI"
    }
  ],
  "identifier": "https://doi.org/10.5281/zenodo.8088760",
  "codeRepository": "https://github.com/assume-framework/assume/",
  "datePublished": "2024-11-15",
  "dateModified": "2024-11-13",
  "dateCreated": "2024-11-13",
  "description": "ASSUME - Agent-based Simulation for Studying and Understanding Market Evolution",
  "keywords": "agent-based, energy market, simulation, reinforcement learning, bidding",
  "license": "AGPL-3.0-or-later",
  "title": "ASSUME",
  "version": "v0.4.3"
}

GitHub Events

Total
  • Create event: 148
  • Release event: 8
  • Issues event: 91
  • Watch event: 28
  • Delete event: 147
  • Member event: 5
  • Issue comment event: 328
  • Push event: 1,231
  • Pull request review event: 438
  • Pull request review comment event: 328
  • Pull request event: 215
  • Fork event: 16
Last Year
  • Create event: 148
  • Release event: 8
  • Issues event: 91
  • Watch event: 28
  • Delete event: 147
  • Member event: 5
  • Issue comment event: 328
  • Push event: 1,231
  • Pull request review event: 438
  • Pull request review comment event: 328
  • Pull request event: 215
  • Fork event: 16

Committers

Last synced: 5 months ago

All Time
  • Total Commits: 1,034
  • Total Committers: 16
  • Avg Commits per committer: 64.625
  • Development Distribution Score (DDS): 0.68
Past Year
  • Commits: 435
  • Committers: 10
  • Avg Commits per committer: 43.5
  • Development Distribution Score (DDS): 0.676
Top Committers
Name Email Commits
Nick Harder n****4@g****m 331
Florian Maurer m****r@f****e 330
kim-mskw k****w@k****u 194
Andreas Eppler A****7@w****e 56
Johanna Adams j****s@t****e 47
mthede m****n@s****u 18
gugrimm 1****m 14
Johanna Adams a****j@t****e 13
Manish Khanra 4****a 12
unknown a****o@w****e 5
Philipp Fritz f****p@o****e 5
tiernan-buckley-ufr t****2@s****e 4
Michael Hafner 1****l 2
DominikBurkert 3****t 1
Hendrik Wulfert H****t@i****e 1
Robbe Sneyders r****s@g****m 1

Issues and Pull Requests

Last synced: 4 months ago

All Time
  • Total issues: 134
  • Total pull requests: 587
  • Average time to close issues: about 2 months
  • Average time to close pull requests: 6 days
  • Total issue authors: 19
  • Total pull request authors: 17
  • Average comments per issue: 1.34
  • Average comments per pull request: 1.72
  • Merged pull requests: 464
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 56
  • Pull requests: 301
  • Average time to close issues: 14 days
  • Average time to close pull requests: 5 days
  • Issue authors: 16
  • Pull request authors: 15
  • Average comments per issue: 1.16
  • Average comments per pull request: 1.86
  • Merged pull requests: 225
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • nick-harder (43)
  • kim-mskw (28)
  • maurerle (19)
  • adamsjohanna (10)
  • dlr-cjs (6)
  • mthede (5)
  • AndreasEppler (4)
  • paragpatil39 (4)
  • Manish-Khanra (3)
  • matthieusirius (2)
  • HafnerMichael (2)
  • fritzphilipp (1)
  • tiernan-buckley-ufr (1)
  • tomissg (1)
  • RobbeSneyders (1)
Pull Request Authors
  • maurerle (216)
  • nick-harder (204)
  • kim-mskw (68)
  • Manish-Khanra (21)
  • adamsjohanna (21)
  • mthede (11)
  • HafnerMichael (9)
  • AndreasEppler (8)
  • tiernan-buckley-ufr (8)
  • paragpatil39 (7)
  • fritzphilipp (4)
  • dlr-cjs (2)
  • gugrimm (2)
  • Graf-Wronski (2)
  • RobbeSneyders (2)
Top Labels
Issue Labels
feature (10) documentation (10) enhancement (9) bug (8) validation (4) tests (4) question (3) examples (3) priority: low (3) Workshop Prep (2) priority: high (1) invalid (1)
Pull Request Labels
feature (5) priority: high (5) enhancement (4) documentation (2) priority: low (2) bug (2) discussion needed (2) examples (1) blocked (1)

Packages

  • Total packages: 3
  • Total downloads:
    • pypi 642 last-month
  • Total dependent packages: 0
    (may contain duplicates)
  • Total dependent repositories: 0
    (may contain duplicates)
  • Total versions: 40
  • Total maintainers: 3
proxy.golang.org: github.com/assume-framework/assume
  • Versions: 16
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent packages count: 5.4%
Average: 5.6%
Dependent repos count: 5.8%
Last synced: 4 months ago
pypi.org: assume-framework

ASSUME - Agent-Based Electricity Markets Simulation Toolbox

  • Versions: 20
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 491 Last month
Rankings
Dependent packages count: 7.4%
Stargazers count: 21.6%
Forks count: 22.8%
Average: 30.2%
Dependent repos count: 69.1%
Maintainers (2)
Last synced: 4 months ago
pypi.org: peakshaving-analyzer

Peak shaving analysis for industrial load profiles

  • Versions: 4
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 151 Last month
Rankings
Dependent packages count: 9.3%
Average: 30.8%
Dependent repos count: 52.3%
Maintainers (2)
Last synced: 4 months ago

Dependencies

.github/workflows/docker-publish.yml actions
  • 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
.github/workflows/lint-pytest.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • actions/upload-artifact v3 composite
  • codecov/codecov-action v3 composite
Dockerfile docker
  • python 3.11-bookworm build
environment.yml pypi
pyproject.toml pypi
  • 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