Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DNMY] Add conventions to README #72

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

Conversation

euronion
Copy link
Collaborator

@euronion euronion commented Feb 3, 2023

I think we should write down a few conventions and try to make the repository comply to them as far as possible

I have added a few ideas, happy to receive feedback.

Checklist

  • Code changes are sufficiently documented; i.e. new functions contain docstrings and further explanations may be given in doc.
  • Data source for new technologies is cleary stated.
  • Newly introduced dependencies are added to environment.yaml (if applicable).
  • A note for the release notes doc/release_notes.rst of the upcoming release is included.
  • I consent to the release of this PR's code under the GPLv3 license.

@energyLS
Copy link

energyLS commented Mar 7, 2023

@energyLS request for comment (DNMY: Do not merge yet)

The following conventions are recommended for new additions to the repository.
Care must be taken with legacy entries, of which not all follow these conventions.

* Energy units: Use MWh and MW or kWh and kW

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggestion:

  • Investment costs in EUR/kW (or EUR/kWh for stores) -> increase readability
  • Energy and VOM in EUR/MWh

* Energy units: Use MWh and MW or kWh and kW
Thermal energy content: When referring to the thermal energy content of a mass or volume, use the Lower Heating Value (LHV)
* Currency-values are specified in EUR
* Ambigiuous units are avoided by specifying whether the unit applies to the input or the output of a process, e.g. the capacity of hydrogen electrolysis "MW_e" refers to "MW" of electricity input capacity whilst "MW_H2" refers to "MW" of output hydrogen

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The convention seems that capacity is mainly expressed in the output capacity. When there are multiple outputs, the one with the highest exergy is used. Exceptions are electrolysis and solar thermal.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • Yes, for some processes like electrolysis and solar thermal it makes sense to specify them based on their input, increasing also the comparability between different electrolysis technologies (and in the future potentially allowing for load-dependent efficiencies).

  • I'd say it is less about the exergy content and more about the purpose of the process, i.e. what's the desired output. It should usually overlap, with the "output" definition being easier understood and better applicable to processes like desalination or DAC.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: ⚙️ In progress
Development

Successfully merging this pull request may close these issues.

3 participants