Skip to content

Create FAQ page in sphinx User Guide #1549

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

Merged
merged 15 commits into from
Dec 2, 2022
Merged

Conversation

kandersolar
Copy link
Member

@kandersolar kandersolar commented Sep 13, 2022

  • Closes Consider creating an FAQ page in the User Guide #1546
  • I am familiar with the contributing guidelines
  • [ ] Tests added
  • [ ] Updates entries in docs/sphinx/source/reference for API changes.
  • Adds description and name entries in the appropriate "what's new" file in docs/sphinx/source/whatsnew for all changes. Includes link to the GitHub Issue with :issue:`num` or this Pull Request with :pull:`num`. Includes contributor name and/or GitHub username (link with :ghuser:`user`).
  • [ ] New code is fully documented. Includes numpydoc compliant docstrings, examples, and comments where necessary.
  • Pull request is nearly complete and ready for detailed review.
  • Maintainer: Appropriate GitHub Labels (including remote-data) and Milestone are assigned to the Pull Request and linked Issue.

Here's a first crack at an FAQ page. Additions and revisions are very welcome. I've marked it for 0.9.3 but also fine to push it to later.

Rendered page: https://pvlib-python--1549.org.readthedocs.build/en/1549/user_guide/faq.html

@kandersolar kandersolar added this to the 0.9.3 milestone Sep 13, 2022
@AdamRJensen
Copy link
Member

Hi @kanderso-nrel

pvlib sounds pretty cool! Is there anything I shouldn't use pvlib for or that it can't do? Financial calculations, uneven terrain?

@AdamRJensen
Copy link
Member

Where can I get irradiance data for my simulation?
pvlib has a module called iotools which has several functions for retrieving irradiance data as well as reading standard file formats such as EPW, TMY2, and TMY3. For free irradiance data, you may consider NREL's NSRDB which can be accessed using the (:func:pvlib.iotools.get_psm3 function and is available for North America. For Europe and Africa, you may consider looking into CAMS (:func:pvlib.iotools.get_cams). PVGIS (:func:pvlib.iotools.get_pvgis_hourly) is another option, which provides irradiance from several different databases with near global coverage. pvlib also has functions for accessing a plethora of ground-measured irradiance datasets, including the BSRN, SURFRAD, SRML, and NREL's MIDC.

@kandersolar
Copy link
Member Author

pvlib sounds pretty cool!

Glad to hear you think so! I agree :)

Is there anything I shouldn't use pvlib for or that it can't do? Financial calculations, uneven terrain?

I'm a little hesitant to include a list of things that pvlib is unsuitable for. For one, that list is infinitely long. For another, what is unsuitable depends on the user -- for example I myself would surely turn to pvlib if I were tasked with modeling a system on uneven terrain, but I might not recommend others do the same. I did try to implicitly address the financial calculations point by specifying electrical performance in the "what is pvlib?" question.

On the other hand, "how do I model variable terrain in pvlib?" has been asked before, so maybe that should be an item on its own?

@kandersolar kandersolar modified the milestones: 0.9.3, 0.9.4 Sep 14, 2022
@kandersolar
Copy link
Member Author

I have added a link to the README as @cwhanse suggested in #1546 (comment).

Finding myself with no motivation to write an entry on variable terrain, I suggest we proceed with the current set of FAQ entries and expand the list in future PRs.

Copy link
Member

@cwhanse cwhanse left a comment

Choose a reason for hiding this comment

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

Approving, some optional edits if you agree that they add clarification.

Copy link
Member

@adriesse adriesse left a comment

Choose a reason for hiding this comment

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

Looks good to me.

@kandersolar kandersolar merged commit c78b50f into pvlib:main Dec 2, 2022
@kandersolar kandersolar deleted the faq branch December 2, 2022 22:10
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.

Consider creating an FAQ page in the User Guide
4 participants