Skip to content

Consider creating an FAQ page in the User Guide #1546

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

Closed
kandersolar opened this issue Sep 6, 2022 · 2 comments · Fixed by #1549
Closed

Consider creating an FAQ page in the User Guide #1546

kandersolar opened this issue Sep 6, 2022 · 2 comments · Fixed by #1549
Milestone

Comments

@kandersolar
Copy link
Member

Is your feature request related to a problem? Please describe.
As with any software package with sufficiently large number of users, some usage questions get asked again and again. Giving the askers the benefit of the doubt that they did some searching before posting their question, I will vouch that search engines are not always very useful if you don't know the magic terms of art to search for.

Describe the solution you'd like
An FAQ page for things that get asked frequently but might not be found easily anywhere else in our docs.

Off the top of my head, here are some ideas for things it could cover:

  • What is pvlib?
  • How does pvlib compare to other tools (PVsyst, SAM, et al)
  • All I have is GHI, how do I get to POA?
  • Can I use PVsyst files (PAN/OND) files with pvlib?
  • Why don't my simulation results make sense? (answer: check timezone localization)
  • I got a warning like RuntimeWarning: invalid value encountered in arccos, what does it mean?
  • [your suggestions here]

I'm sure trawling github issues/discussions, stackoverflow, and google group threads would turn up more good things to include.

It might also be a good idea to explicitly try to speak "plain english" in FAQ entries, at least for the title of each entry. For example an entry might be better titled "All I have is GHI, how do I get POA?" than something mentioning diffuse components and decomposition models.

Describe alternatives you've considered
N/A

Additional context
N/A

@cwhanse
Copy link
Member

cwhanse commented Sep 6, 2022

This is a good idea. It would be nice to place the link prominently on the top half of the README page.

@AdamRJensen
Copy link
Member

Great! A question concerning when to use pvlib and when not to use pvlib (e.g., financial calculations) would be a great addition.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants