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

Add documentation for relevant node attributes #158

Open
13 tasks
mabijkerk opened this issue Aug 16, 2023 · 0 comments
Open
13 tasks

Add documentation for relevant node attributes #158

mabijkerk opened this issue Aug 16, 2023 · 0 comments
Assignees

Comments

@mabijkerk
Copy link
Member

mabijkerk commented Aug 16, 2023

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:

  • Free_co2_factor
  • Land_use_per_unit
  • Takes_part_in_ets
  • Energy_balance_group (?)
  • Forecasting_error (deprecated)
  • Part_load_efficiency_penalty (deprecated)
  • Part_load_operating_point (deprecated)
  • Hours_maint_nl (deprecated)
  • Hours_place_nl (deprecated)
  • Hours_prep_nl (deprecated)
  • use = energetic/non_energetic/undefined
  • waste_outputs
  • ...

Notifying @thomas-qah and @redekok

@mabijkerk mabijkerk self-assigned this Aug 16, 2023
@mabijkerk mabijkerk changed the title Add documentation on node attributes Add documentation on unclear node attributes Aug 16, 2023
@mabijkerk mabijkerk changed the title Add documentation on unclear node attributes Add documentation on 'vague' node attributes Aug 16, 2023
@mabijkerk mabijkerk changed the title Add documentation on 'vague' node attributes Add documentation for relveant node attributes Jul 31, 2024
@mabijkerk mabijkerk changed the title Add documentation for relveant node attributes Add documentation for relevant node attributes Nov 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants