Skip to content

Commit

Permalink
Merge pull request #70 from pommes-public/69-make-authors-and-contrib…
Browse files Browse the repository at this point in the history 
…utions-reflect-the-actual-situation

Make authors and contributions reflect the actual situation
  • Loading branch information
@jokochems
jokochems authored Apr 13, 2024
2 parents 4289665 + 2eb01c2 commit e7be53c
Show file tree
Hide file tree
Showing 9 changed files with 73 additions and 91 deletions.
27 changes: 2 additions & 25 deletions CITATION.cff
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,31 +6,8 @@ authors:
- family-names: Werner
given-names: Yannick
orcid: "https://orcid.org/0000-0002-6674-805X"
- family-names: Giehl
given-names: Johannes
orcid: "https://orcid.org/0000-0002-1769-1907"
- family-names: Grosse
given-names: Benjamin
orcid: "https://orcid.org/0000-0002-3323-9734"
- family-names: Westphal
given-names: Sophie
- family-names: "Mikulicz-Radecki"
given-names: Flora
- family-names: Spiller
given-names: Carla
- family-names: "Büllesbach"
given-names: Fabian
- family-names: Ghosh
given-names: Timona
- family-names: Verwiebe
given-names: Paul
orcid: "https://orcid.org/0000-0002-6877-2846"
- family-names: "Encinas-Rosa"
given-names: Leticia
- family-names: "Müller-Kirchenbauer"
given-names: Joachim
cff-version: "1.1.0"
date-released: 2021-10-15
cff-version: "1.2.0"
date-released: 2024-04-13
doi: https://doi.org/
keywords:
- "power market"
Expand Down
63 changes: 37 additions & 26 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -92,36 +92,47 @@ Every kind of contribution or feedback is warmly welcome.<br>
We use the [GitHub issue management](https://github.com/pommes-public/pommesdispatch/issues) as well as
[pull requests](https://github.com/pommes-public/pommesdispatch/pulls) for collaboration. We try to stick to the PEP8 coding standards.

The following people have contributed in the following manner to `pommesdispatch`:

| Name | Contribution | Status |
| ---- | ---- | ---- |
| Johannes Kochems | major development & conceptualization<br>conceptualization, core functionality (esp. dispatch, power prices, demand response, rolling horizon modeling), architecture, publishing process | coordinator & maintainer,<br>developer & corresponding author |
| Yannick Werner | major development & conceptualization<br>conceptualization, core functionality (esp. exchange, RES, CHP modeling), interface to pommesdata | developer & corresponding author |
| Johannes Giehl | development<br>early-stage core functionality | developer |
| Benjamin Grosse | development<br>support for conceptualization, early-stage contributions at the interface to pommesdata | developer |
| Sophie Westphal | development<br>early-stage contributions at the interface to pommesdata | former developer (student assistant) |
| Flora von Mikulicz-Radecki | testing<br>early-stage comprehensive testing | former tester (student assistant) |
| Carla Spiller | development<br>early-stage rolling horizon and cross-border exchange integration | former developer (student assistant) |
| Fabian Büllesbach | development<br>early-stage rolling horizon implementation | former developer (master's student) |
| Timona Ghosh | development<br>early-stage cross-border exchange implementation | former developer (master's student) |
| Paul Verwiebe | support<br>support of early-stage core functionality development | former supporter (research associate) |
| Leticia Encinas Rosa | support<br>support of early-stage core functionality development | former supporter (research associate) |
| Joachim Müller-Kirchenbauer | support & conceptualization<br>early-stage conceptualization, funding | supporter (university professor) |

*Note: Not every single contribution is reflected in the current version of
`pommesdispatch`. This is especially true for those marked as early-stage
contributions that may have been extended, altered or sometimes discarded.
Nonetheless, all people listed have made valuable contributions. The ones
discarded might be re-integrated at some point in time.
Dedicated contributions to `pommesdata` and `pommesinvest` are not included
in the list, but listed individually for these projects.*
### Authors
* Authors of `pommesinvest` are Johannes Kochems and Yannick Werner. It is maintained by Johannes Kochems.
* All people mentioned below contributed to early-stage versions or predecessors of POMMES or ideally supported it.

### List of contributors to POMMES
The following people have contributed to *POMMES*.
Most of these contributions belong to early-stage versions and are not part
of the actual source code. Nonetheless, all contributions shall be acknowledged and the full list is provided for transparency reasons.

The main contributors are stated on top, the remainder
is listed in alphabetical order.

| Name | Contribution |
|--------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Johannes Kochems | major development & conceptualization<br>conceptualization, development of all investment-related parts; development of main data preparation routines (esp. future projection for all components, RES tender data and LCOE estimates, documentation), architecture, publishing process, maintenance |
| Yannick Werner | major development & conceptualization<br>conceptualization, development of main data preparation routines (status quo data for all components, detailed RES, interconnector and hydro data), architecture |
| Benjamin Grosse | data collection for conventional power plants in early development stage, ideal support and conceptionel counseling |
| Carla Spiller | data collection for conventional power plants in early stage development as an input to *pommesdata*; co-development of rolling horizon dispatch modelling in predecessor of *pommesdispatch* |
| Christian Fraatz | data collection for conventional power plants in early stage development as an input to *pommesdata* |
| Conrad Nicklisch | data collection for RES in early stage development as an input to *pommesdata* |
| Daniel Peschel | data collection on CHP power plants as an input to *pommesdata* |
| Dr. Johannes Giehl | conceptionel support and research of data licensing; conceptionel support for investment modelling in *pommesinvest* |
| Dr. Paul Verwiebe | development of small test models as a predecessor of POMMES |
| Fabian Büllesbach | development of a predecessor of the rolling horizon modeling approach in *pommesdispatch* |
| Flora von Mikulicz-Radecki | extensive code and functionality testing in an early development stage for predecessors of *pommesdispatch* and *pommesinvest* |
| Florian Maurer | support with / fix for python dependencies |
| Hannes Kachel | development and analysis of approaches for complexity reduction in a predecessor of *pommesinvest* |
| Julian Endres | data collection for costs and conventional power plants in early stage development |
| Julien Faist | data collection for original coal power plant shutdown and planned installation of new power plants for *pommesdata*; co-development of a predecessor of *pommesinvest* |
| Leticia Encinas Rosa | ata collection for conventional power plants in early stage development as an input to *pommesdata* |
| Prof. Dr.-Ing. Joachim Müller-Kirchenbauer | funding, enabling and conceptual support |
| Robin Claus | data collection for RES in early stage development as an input to *pommesdata* |
| Sophie Westphal | data collection for costs and conventional power plants in early stage development as an input for *pommesdata* |
| Timona Ghosh | data collection for interconnector data as an input to *pommesdata* |


## Citing
A publication using and introducing `pommesdispatch` is currently in preparation.

If you are using `pommesdispatch` for your own analyses, we recommend citing as:<br>
*Kochems, J.; Werner, Y.; Giehl, J.; Grosse, B. et al. (2021): pommesdispatch. A bottom-up fundamental power market model for the German electricity sector. https://github.com/pommes-public/pommesdispatch, accessed YYYY-MM-DD.*
*Kochems, J. and Werner, Y. (2024): pommesdispatch. A bottom-up fundamental power market model for the German electricity sector. https://github.com/pommes-public/pommesdispatch, accessed YYYY-MM-DD.*

We furthermore recommend naming the version tag or the commit hash used for the sake of transparency and reproducibility.

Expand All @@ -130,7 +141,7 @@ Also see the *CITATION.cff* file for citation information.
## License
This software is licensed under MIT License.

Copyright 2021 pommes developer group
Copyright 2024 pommes developer group

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

Expand Down
2 changes: 1 addition & 1 deletion docs/conf.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
# -- Project information -----------------------------------------------------

project = "pommesdispatch"
copyright = "2021, pommes developer group"
copyright = "2024, pommes developer group"
author = "pommes developer group"

# -- General configuration ---------------------------------------------------
Expand Down
9 changes: 1 addition & 8 deletions pommesdispatch/model/dispatch_model.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38,14 +38,7 @@
-------------------------
See `environments.yml` file
@author: Johannes Kochems (*), Yannick Werner (*), Johannes Giehl,
Benjamin Grosse
Contributors:
Sophie Westphal, Flora von Mikulicz-Radecki, Carla Spiller, Fabian Büllesbach,
Timona Ghosh, Paul Verwiebe, Leticia Encinas Rosa, Joachim Müller-Kirchenbauer
(*) Corresponding authors
@author: Johannes Kochems, Yannick Werner
"""

import argparse
Expand Down
9 changes: 1 addition & 8 deletions pommesdispatch/model_funcs/data_input.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,7 @@
This file contains all function definitions for reading in input data
used for the dispatch variant of POMMES.
@author: Johannes Kochems (*), Yannick Werner (*), Johannes Giehl,
Benjamin Grosse
Contributors:
Sophie Westphal, Flora von Mikulicz-Radecki, Carla Spiller, Fabian Büllesbach,
Timona Ghosh, Paul Verwiebe, Leticia Encinas Rosa, Joachim Müller-Kirchenbauer
(*) Corresponding authors
@author: Johannes Kochems, Yannick Werner
"""
import pandas as pd

Expand Down
9 changes: 1 addition & 8 deletions pommesdispatch/model_funcs/model_control.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,7 @@
This file contains all class and function definitions for controlling the model
workflow of the dispatch variant of POMMES.
@author: Johannes Kochems (*), Yannick Werner (*), Johannes Giehl,
Benjamin Grosse
Contributors:
Sophie Westphal, Flora von Mikulicz-Radecki, Carla Spiller, Fabian Büllesbach,
Timona Ghosh, Paul Verwiebe, Leticia Encinas Rosa, Joachim Müller-Kirchenbauer
(*) Corresponding authors
@author: Johannes Kochems, Yannick Werner
"""

import logging
Expand Down
12 changes: 12 additions & 0 deletions pommesdispatch/model_funcs/results_processing.py
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,15 @@
# -*- coding: utf-8 -*-
"""
General description
-------------------
These are processing routines used in the power market model POMMES.
Installation requirements
-------------------------
Python version >= 3.8
@author: Johannes Kochems
"""
import pandas as pd


Expand Down
9 changes: 1 addition & 8 deletions pommesdispatch/model_funcs/subroutines.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,7 @@
and returns this to create_XX_transformers as node_dict[i], so the i_th
element to be build
@author: Johannes Kochems (*), Yannick Werner (*), Johannes Giehl,
Benjamin Grosse
Contributors:
Sophie Westphal, Flora von Mikulicz-Radecki, Carla Spiller, Fabian Büllesbach,
Timona Ghosh, Paul Verwiebe, Leticia Encinas Rosa, Joachim Müller-Kirchenbauer
(*) Corresponding authors
@author: Johannes Kochems, Yannick Werner
"""
import math

Expand Down
24 changes: 17 additions & 7 deletions setup.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,19 +21,29 @@ def get_version(rel_path):
__author__ = [
"Johannes Kochems",
"Yannick Werner",
"Johannes Giehl",
"Benjamin Grosse",
]
__copyright__ = "Copyright 2021 pommes developer group"
__credits__ = [
"Sophie Westphal",
"Flora von Mikulicz-Radecki",
"Benjamin Grosse",
"Carla Spiller",
"Christian Fraatz",
"Conrad Nicklisch",
"Daniel Peschel",
"Dr. Johannes Giehl",
"Dr. Paul Verwiebe",
"Fabian Büllesbach",
"Timona Ghosh",
"Paul Verwiebe",
"Sophie Westphal",
"Flora von Mikulicz-Radecki",
"Florian Maurer",
"Hannes Kachel",
"Julian Endres",
"Julien Faist",
"Leticia Encinas Rosa",
"Joachim Müller-Kirchenbauer",
"Carla Spiller",
"Prof. Dr.-Ing. Joachim Müller-Kirchenbauer",
"Robin Claus",
"Sophie Westphal",
"Timona Ghosh"
]

__license__ = "MIT"
Expand Down

0 comments on commit e7be53c

Please sign in to comment.