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 doc #265

Merged
merged 175 commits into from
Nov 27, 2022
Merged

Improve doc #265

merged 175 commits into from
Nov 27, 2022

Conversation

martavp
Copy link
Member

@martavp martavp commented Sep 2, 2022

At AU, we have been working on improving the documentation.

We are still missing a few tasks before this PR is ready to be reviewed, but @Parisra, @Adam-Dvorak1 and @ebbekyhl will take care of them next week

TODOs LIST

[x] Add internal links from some sections to others

[x] Harmonize style in title and subtitle

[x] Review the description of the myopic approach and describe better carbon budget

[x] Finish and review Other industrial sectors

[x] Add description of energy consumption in agriculture

[ ] Create an overview of the rules like in PyPSA-Eur (maybe this can be done in a future step)

martavp and others added 30 commits August 10, 2022 07:24
Test number two. Let's hope for the best.
This reverts commit a978f78, reversing
changes made to c3e1a55.
This reverts commit a978f78, reversing
changes made to c3e1a55.
This reverts commit c3e1a55, reversing
changes made to 06d5922.
Updated version of the biomass description. Links to other parts of the documentation still needs to be added.
Adding some headlines for transportation.
Adding text for shipping. Internal links needs to be updated.
General comment on transport.
Description of aviation. It is pretty simple.
Adding hydrogen and oil-based products sections. Add one figure
Adam-Dvorak1 and others added 25 commits November 23, 2022 14:11
This pull requests updates all of the $$ $$ equation symbols and $ $ in line symbols with rst/html compatible symbols
Co-authored-by: energyLS <89515385+energyLS@users.noreply.github.com>
Co-authored-by: energyLS <89515385+energyLS@users.noreply.github.com>
Co-authored-by: energyLS <89515385+energyLS@users.noreply.github.com>
Co-authored-by: energyLS <89515385+energyLS@users.noreply.github.com>
Co-authored-by: energyLS <89515385+energyLS@users.noreply.github.com>
Co-authored-by: energyLS <89515385+energyLS@users.noreply.github.com>
Co-authored-by: energyLS <89515385+energyLS@users.noreply.github.com>
Co-authored-by: energyLS <89515385+energyLS@users.noreply.github.com>
Co-authored-by: energyLS <89515385+energyLS@users.noreply.github.com>
Co-authored-by: energyLS <89515385+energyLS@users.noreply.github.com>
Co-authored-by: energyLS <89515385+energyLS@users.noreply.github.com>
Co-authored-by: energyLS <89515385+energyLS@users.noreply.github.com>
Co-authored-by: energyLS <89515385+energyLS@users.noreply.github.com>
Co-authored-by: energyLS <89515385+energyLS@users.noreply.github.com>
Co-authored-by: energyLS <89515385+energyLS@users.noreply.github.com>
Co-authored-by: energyLS <89515385+energyLS@users.noreply.github.com>
Co-authored-by: energyLS <89515385+energyLS@users.noreply.github.com>
Co-authored-by: energyLS <89515385+energyLS@users.noreply.github.com>
Co-authored-by: energyLS <89515385+energyLS@users.noreply.github.com>
Co-authored-by: energyLS <89515385+energyLS@users.noreply.github.com>
@fneum fneum merged commit 5ee9e97 into PyPSA:master Nov 27, 2022
@fneum
Copy link
Member

fneum commented Nov 27, 2022

Great! Thanks for all your work! The references to lines in the config.yaml will be hard to maintain, but we can find a solution separately from this PR.

@martavp
Copy link
Member Author

martavp commented Nov 27, 2022

Finished the review of supply_demand.rst. Great effort, detailed descriptions, well readable. The suggestions are mainly typos. The cross-referencing to subsections seems not to work, please doublecheck. The industry section was tiring to read since it is very detailed, but that's adequate and how it should be :)

thanks for the review, @energyLS Yes, industry always super long to describe :)

@martavp
Copy link
Member Author

martavp commented Nov 27, 2022

Great! Thanks for all your work! The references to lines in the config.yaml will be hard to maintain, but we can find a solution separately from this PR.

Sure, we can find other ways to do it. I think it always clarifies to have a direct link between the documentation and where to change a particular assumption.

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

Successfully merging this pull request may close these issues.

7 participants