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 reliability assessment #83

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

Add reliability assessment #83

wants to merge 5 commits into from

Conversation

rouille
Copy link
Collaborator

@rouille rouille commented May 10, 2023

Pull Request doc

Purpose

Add reliability assessment documentation to website. Note that docstring are poorly formatted and do not render well. This will need to be fixed at some point.

What the code is doing

N/A

Testing

Generated documentation locally successfully.

Where to look

Usage Example/Visuals

See content of PR #99 in reliability-assessment repo.

Time estimate

5min

@rouille rouille added the documentation Improvements or additions to documentation label May 10, 2023
@rouille rouille requested review from yixingxu, BainanXia and jenhagg May 10, 2023 23:26
@rouille rouille self-assigned this May 10, 2023
"prereise/demand/transportation_electrification/data.rst",
"prereise/demand/transportation_electrification/methodology.rst",
"prereise.gather.flexibilitydata.doe.examples.rst",
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Exclude scripts generating a lot of files

"modules.rst",
"setup.rst",
"prereise/hydro/legacy/capacity_factor.rst",
"prereise/renewables/solar/wind.rst",
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Exclude outdated documentation. Hydro profiles and solar profiles using capacity factors and WIND toolkit, respectively, are not used anymore

"prereise/demand/transportation_electrification/data.rst",
"prereise/demand/transportation_electrification/methodology.rst",
"prereise.gather.flexibilitydata.doe.examples.rst",
"postreise/README.md"
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Exclude README explaining how to generate plots in the PostREISE tutorial.

"prereise/demand/transportation_electrification/data.rst",
"prereise/demand/transportation_electrification/methodology.rst",
"prereise.gather.flexibilitydata.doe.examples.rst",
"postreise/README.md"
"reliabilityassessment/usage.rst",
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Solve an issue with numref

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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant