[Documentation] Add details and equations to output KPI descriptions

rl-institut / multi-vector-simulator

Multi-vector Simulation Tool assessing and optimizing Local Energy Systems (LES) for the E-LAND project

GNU General Public License v2.0

21 stars 10 forks source link

[Documentation] Add details and equations to output KPI descriptions #883

Open smartie2076 opened 3 years ago

smartie2076 commented 3 years ago

The description of equation parameters should all ressemble the one of the renewable factor, some of the equation below do not define their variables in the same fashion

Each KPI should have an

[ ] Example
[ ] Underlying equation
[ ] Expected range
[ ] A :notes: box hinting at specific weird output cases (eg. negative DOA)

Originally posted by @smartie2076 in https://github.com/rl-institut/multi-vector-simulator/issues/878#issuecomment-834235341