quintel / documentation

Documentation for the Energytransitionmodel.
https://docs.energytransitionmodel.com
6 stars 6 forks source link

Add documentation for relveant node attributes #158

Open mabijkerk opened 1 year ago

mabijkerk commented 1 year ago

Background The node source analyses contain attributes like free_co2_factor and modellers often wonder whether how to interpret these. It would be useful to maintain documentation that explains the function of attributes like this, as well as stating whether they are deprecated or not.

Goal Add documentation about node attributes to the "For contributors" page. ETSource only contains a short reference to input and output conversions. Documentation should include an explanation of the attribute and whether it is still used.

Focus should be on generic attributes that are used in most nodes, but whose function does not immediately become clear from the name. For example, initial_investment or output.loss are rather clear, so don't have priority, but free_co2_factor is less clear.

Non-exhaustive list of relevant attributes:

Notifying @thomas-qah and @redekok