add joss paper

create using
pandoc -s paper.md -o paper.pdf --bibliography paper.bib  --citeproc

codemeta.json

@@ -0,0 +1,44 @@
+{
+  "@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 Kira 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"
+}

codemeta.json.license

@@ -0,0 +1,3 @@
+SPDX-FileCopyrightText: ASSUME Developers
+
+SPDX-License-Identifier: AGPL-3.0-or-later

paper/paper.bib

@@ -0,0 +1,105 @@
+@Comment{
+SPDX-FileCopyrightText: ASSUME Developers
+
+SPDX-License-Identifier: AGPL-3.0-or-later
+}
+
+@incollection{maurerMarketAbstractionEnergy2023,
+  title = {Market {{Abstraction}} of {{Energy Markets}} and {{Policies}} - {{Application}} in an {{Agent-Based Modeling Toolbox}}},
+  booktitle = {Energy {{Informatics}}},
+  author = {Maurer, Florian and Miskiw, Kim K. and Acosta, Rebeca Ramirez and Harder, Nick and Sander, Volker and Lehnhoff, Sebastian},
+  editor = {J{\o}rgensen, Bo N{\o}rregaard and Da Silva, Luiz Carlos Pereira and Ma, Zheng},
+  year = {2023},
+  month = dec,
+  volume = {14468},
+  pages = {139--157},
+  publisher = {Springer Nature Switzerland},
+  address = {Cham},
+  doi = {10.1007/978-3-031-48652-4_10},
+  isbn = {978-3-031-48652-4},
+}
+
+@inproceedings{maurerKnowYourTools2024,
+  title = {Know {{Your Tools}} - {{A Comparison}} of {{Two Open Agent-Based Energy Market Models}}},
+  booktitle = {2024 20th {{International Conference}} on the {{European Energy Market}} ({{EEM}})},
+  author = {Maurer, Florian and Nitsch, Felix and Kochems, Johannes and Schimeczek, Christoph and Sander, Volker and Lehnhoff, Sebastian},
+  year = {2024},
+  month = jun,
+  pages = {1--8},
+  issn = {2165-4093},
+  doi = {10.1109/EEM60825.2024.10609021},
+}
+
+@inproceedings{miskiwExplainableDeepReinforcement2024,
+  title = {Explainable {{Deep Reinforcement Learning}} for {{Multi-Agent Electricity Market Simulations}}},
+  booktitle = {2024 20th {{International Conference}} on the {{European Energy Market}} ({{EEM}})},
+  author = {Miskiw, Kim K. and Staudt, Philipp},
+  year = {2024},
+  month = jun,
+  pages = {1--9},
+  issn = {2165-4093},
+  doi = {10.1109/EEM60825.2024.10608907},
+}
+
+
+@inproceedings{khanraEconomicEvaluationElectricity2024,
+  title = {Economic {{Evaluation}} of {{Electricity}} and {{Hydrogen-Based Steel Production Pathways}}: {{Leveraging Market Dynamics}} and {{Grid Congestion Mitigation}} through {{Demand Side Flexibility}}},
+  shorttitle = {Economic {{Evaluation}} of {{Electricity}} and {{Hydrogen-Based Steel Production Pathways}}},
+  booktitle = {2024 20th {{International Conference}} on the {{European Energy Market}} ({{EEM}})},
+  author = {Khanra, Manish and Klobasa, Marian and Patil, Parag and Scholz, Daniel},
+  year = {2024},
+  month = jun,
+  pages = {1--6},
+  issn = {2165-4093},
+  doi = {10.1109/EEM60825.2024.10608890},
+}
+
+@inproceedings{adamsBlockOrdersMatter2024,
+  title = {Do {{Block Orders Matter}}? {{Impact}} of {{Regular Block}} and {{Linked Orders}} on {{Electricity Market Simulation Outcomes}}},
+  shorttitle = {Do {{Block Orders Matter}}?},
+  booktitle = {2024 20th {{International Conference}} on the {{European Energy Market}} ({{EEM}})},
+  author = {Adams, Johanna and Harder, Nick and Weidlich, Anke},
+  date = {2024-06},
+  pages = {1--7},
+  issn = {2165-4093},
+  doi = {10.1109/EEM60825.2024.10608956},
+}
+
+
+@article{harderHowSatisfactoryCan2024,
+  title = {How {{Satisfactory Can Deep Reinforcement Learning Methods Simulate Electricity Market Dynamics}}? {{Bechmarking}} via {{Bi-level Optimization}}},
+  shorttitle = {How {{Satisfactory Can Deep Reinforcement Learning Methods Simulate Electricity Market Dynamics}}?},
+  author = {Nick Harder and Lesia Mitridati and Farzaneh Pourahmadi and Anke Weidlich and Jalal Kazempour},
+  year = {2024},
+  month = oct,
+  journal = {Energy Informatics Review},
+}
+
+
+@inproceedings{bublitzAgentbasedSimulationGerman2014,
+  title = {Agent-Based {{Simulation}} of the {{German}} and {{French Wholesale Electricity Markets}}},
+  booktitle = {Proceedings of the 6th {{International Conference}} on {{Agents}} and {{Artificial Intelligence}} - {{Volume}} 2},
+  author = {Bublitz, Andreas and Ringler, Philipp and Genoese, Massimo and Fichtner, Wolf},
+  year = {2014},
+  month = mar,
+  series = {{{ICAART}} 2014},
+  pages = {40--49},
+  publisher = {{SCITEPRESS - Science and Technology Publications, Lda}},
+  address = {Setubal, PRT},
+  doi = {10.5220/0004760000400049},
+  urldate = {2023-05-15},
+  isbn = {978-989-758-016-1},
+}
+
+@article{schimeczekAMIRISAgentbasedMarket2023,
+  title = {{{AMIRIS}}: {{Agent-based Market}} Model for the {{Investigationof Renewable}} and {{Integrated}} Energy {{Systems}}},
+  shorttitle = {{{AMIRIS}}},
+  author = {Schimeczek, Christoph and Nienhaus, Kristina and Frey, Ulrich and Sperber, Evelyn and Sarfarazi, Seyedfarzad and Nitsch, Felix and Kochems, Johannes and Ghazi, A. Achraf El},
+  year = {2023},
+  month = apr,
+  journal = {Journal of Open Source Software},
+  volume = {8},
+  number = {84},
+  issn = {2475-9066},
+  doi = {10.21105/joss.05041},
+}

paper/paper.md

@@ -0,0 +1,83 @@
+<!--
+SPDX-FileCopyrightText: ASSUME Developers
+
+SPDX-License-Identifier: AGPL-3.0-or-later
+-->
+
+---
+title: 'ASSUME - Agent-based Simulation for Studying and Understanding Market Evolution'
+tags:
+  - Python
+  - agent based simulation
+  - energy market
+  - reinforcement learning
+  - market simulation
+  - simulation
+authors:
+  - name: Florian Maurer
+    orcid: 0000-0001-8345-3889
+    corresponding: true
+    affiliation: 1
+    "affiliation": 1
+  - name: Nick Harder
+    orcid: 0000-0003-1897-3671
+    "affiliation": 2
+  - name: Kim Kira Miskiw
+    orcid: 0009-0009-1389-4844
+    affiliation: 3
+  - name: Manish Khanra
+    orcid: 0000-0002-3347-9922
+    affiliation: 4
+
+affiliations:
+ - name: University of Applied Sciences Aachen, Germany
+   index: 1
+ - name: Inatech Universität Freiburg, Germany
+   index: 2
+ - name: Karlsruhe Institute of Technology, Germany
+   index: 3
+ - name: Fraunhofer Institute for Software and Systems Engineering, Germany
+   index: 4
+date: 13 November 2024
+bibliography: paper.bib
+---
+
+<!-- pandoc -s paper.md -o paper.pdf --bibliography paper.bib --csl=apa.csl --filter pandoc-citeproc --pdf-engine=xelatex-->
+
+# Summary
+
+**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.
+
+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.
+
+# Statement of need
+
+While different other agent-based models have been developed for the study of energy markets, such as PowerACE [@bublitzAgentbasedSimulationGerman2014] and AMIRIS [@schimeczekAMIRISAgentbasedMarket2023], the possible integration of reinforcement learning methods into the behavioral strategies of market agents is currently unique to ASSUME.
+This feature allows for the exploration of new market designs and dynamics in energy markets using a common open-source simulation framework.
+Further unique features of `ASSUME` are the extensive market abstraction which allows to define complex multi market scenarios as shown in [@maurerMarketAbstractionEnergy2023].
+ASSUME is designed to provide results which are easily comparable and interactable.
+This is set in contrast to other agent-based simulation frameworks, which are often designed to be used for a specific use case.
+Instead, various moving parts can be configured, such as the market abstraction, the agent properties and bidding strategies, or the reinforcement learning methods.
+
+# Architecture
+
+`ASSUME` builds on the open-source agent-based simulation library [mango-agents](https://pypi.org/project/mango-agents/) to model the simulation world and to give users continuous feedback during the simulation runs.
+Interaction with the results of the simulation is possible through the Grafana dashboards, which do have direct access to the simulation database.
+Additionally, writing the output to CSV files is supported for scenarios in which a database is not available.
+
+New scenarios can be created by providing CSV files, accessing simulation data from a database or by using the object-oriented API, which makes it possible to integrate new classes, maket mechanisms and bidding strategies as well.
+The core overview of available classes and the interaction with the world is shown in \autoref{fig:architecture}.
+
+![Basic Architecture of the ASSUME simulation\label{fig:architecture}](../docs/source/img/architecture.svg)
+
+# Publications
+
+ASSUME has been used to investigate the usage of complex order types like block bids in wholesale markets [@adamsBlockOrdersMatter2024] as well as for the integration of demand-side flexibility and redispatch markets in [@khanraEconomicEvaluationElectricity2024].
+Studies of applicability of reinforcement learning methods in energy markets were tackled in [@harderHowSatisfactoryCan2024], while an analysis of explainable AI methods was appliedd to ASSUME in [@miskiwExplainableDeepReinforcement2024].
+For better interoperability with other energy system model data, adapters to interact from ASSUME with PyPSA and AMIRIS are available and make a comparison to other renomated market simulation tools possible [@maurerKnowYourTools2024].
+
+# Acknowledgements
+
+Kim K. Miskiw, Nick Harder and Manish Khanra thank the German Federal Ministry for Economic Affairs and Climate Action for the funding of the ASSUME project under grant number BMWK 03EI1052A.
+
+# References