Skip to content

Improve the documentation section on assigning weights to the carriers#619

Merged
mahendrark merged 11 commits intodevfrom
fix/improve_rtd_energy_carrier_weighting
Oct 27, 2020
Merged

Improve the documentation section on assigning weights to the carriers#619
mahendrark merged 11 commits intodevfrom
fix/improve_rtd_energy_carrier_weighting

Conversation

@mahendrark
Copy link
Copy Markdown
Contributor

@mahendrark mahendrark commented Oct 26, 2020

Fix #616

Changes proposed in this pull request:

  • Update the description of the method followed to assign weightage to the energy carriers in the code and provide sources

The following steps were realized, as well (if applies):

  • Use in-line comments to explain your code
  • Write docstrings to your code (example docstring)
  • For new functionalities: Explain in readthedocs
  • Write test(s) for your new patch of code (pytests, assertion debug messages)
  • Update the CHANGELOG.md
  • Apply black (black . --exclude docs/)
  • Check if benchmark tests pass locally (EXECUTE_TESTS_ON=master pytest)

Please mark above checkboxes as following:

  • Open
  • Done

❌ Check not applicable to this PR

For more information on how to contribute check the CONTRIBUTING.md.

@mahendrark mahendrark added documentation Improvements or additions to documentation enhancement New feature or request labels Oct 26, 2020
@mahendrark mahendrark force-pushed the fix/improve_rtd_energy_carrier_weighting branch 2 times, most recently from a46aa21 to 7c8a7be Compare October 26, 2020 16:48
@mahendrark
Copy link
Copy Markdown
Contributor Author

mahendrark commented Oct 26, 2020

@Bachibouzouk

I noticed several typos and fixed them in this file. Guess we have to do a review of the docs and see if there are any more typos

Copy link
Copy Markdown
Collaborator

@Bachibouzouk Bachibouzouk left a comment

Choose a reason for hiding this comment

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

The sentence "For most KPIs, including for example the share of renewables at the project location or its self-sufficiency, the baseline energy carrier used is of no relevance as the result is not dependent on it." could be improved a bit (split in two sentences?), otherwise I think it is good

@mahendrark mahendrark force-pushed the fix/improve_rtd_energy_carrier_weighting branch from 4041996 to fd821cc Compare October 27, 2020 10:46
@mahendrark mahendrark merged commit 9e76182 into dev Oct 27, 2020
@mahendrark mahendrark deleted the fix/improve_rtd_energy_carrier_weighting branch October 27, 2020 11:01
@smartie2076
Copy link
Copy Markdown
Collaborator

Nice @mahendrark thank you!

@smartie2076 smartie2076 mentioned this pull request Nov 10, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Documentation] Description of energy carrier weighting

3 participants