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

Improve docs of demandlib #44

Merged
merged 11 commits into from
Dec 15, 2021
Merged

Improve docs of demandlib #44

merged 11 commits into from
Dec 15, 2021

Conversation

uvchik
Copy link
Member

@uvchik uvchik commented Dec 8, 2021

  • description of electricity demand profiles
  • [ ] usage

Docs can be found here.

@uvchik uvchik self-assigned this Dec 8, 2021
@pep8speaks
Copy link

pep8speaks commented Dec 9, 2021

Hello @uvchik! Thanks for updating this PR. We checked the lines you've touched for PEP 8 issues, and found:

There are currently no PEP 8 issues detected in this Pull Request. Cheers! 🍻

Comment last updated at 2021-12-10 08:44:25 UTC

@uvchik uvchik requested a review from a team December 10, 2021 08:45
@uvchik
Copy link
Member Author

uvchik commented Dec 10, 2021

I will not add the usage, because the usage chapter will be created in PR #45. We should merge this first, if its fine for you. I changed the structure of the docs a bit but mainly added content. Nothing fundamental. Proofing would be good, though.

Copy link
Member

@p-snft p-snft left a comment

Choose a reason for hiding this comment

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

The verbosity is very adequate and I don't see any mistakes. Thanks. (Still, you might consider adding a sentence about the limitations of the profiles.)


\theta_0 &= 40^\circ C

Types of houses:
Copy link
Member

Choose a reason for hiding this comment

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

As far as I understand, the profiles include space heating (SH) and domestic hot water (DHW). Thus, they become inaccurate if the insulation is different from the one originally assumed: Demand in summer is dominated by DHW, demand in summer may or may not be dominated by SH - depending on the insulation. (This is also the way, I interpret #20.)

Maybe, this limitation should be made explicit.

Copy link
Member Author

Choose a reason for hiding this comment

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

I just revised the general structure and added some information about electrical load profiles. I did not touch the content of the heat profiles.

@uvchik uvchik mentioned this pull request Dec 15, 2021
4 tasks
@uvchik
Copy link
Member Author

uvchik commented Dec 15, 2021

I added an issue for further ToDo's #48.

@uvchik uvchik merged commit 9acfebc into dev Dec 15, 2021
@uvchik uvchik deleted the docs/improve-docs branch December 15, 2021 13:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants