Skip to content

update spectral_factor_sapm docs #2115

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
RDaxini opened this issue Jul 2, 2024 · 0 comments · Fixed by #2116
Closed

update spectral_factor_sapm docs #2115

RDaxini opened this issue Jul 2, 2024 · 0 comments · Fixed by #2116
Labels
documentation GSoC Contributions related to Google Summer of Code.
Milestone

Comments

@RDaxini
Copy link
Contributor

RDaxini commented Jul 2, 2024

Is your feature request related to a problem? Please describe.
I think the documentation for the spectral_factor_sapm function is lacking detail. There is a comment directing users to sapm() for further detail, but actually I'm not 100% sure what that is--- is it pvsystem.sapm?

Describe the solution you'd like
I'd like to update the docs to a similar level of detail as the other spectral_factor docs. At a minimum:

  • hyperlink the sapm module referenced currently (this page?)
  • Add more information on the model development and other context, including the equation
  • Add references, e.g. 1, e.g. 2, e.g. 3

Describe alternatives you've considered
I understand that the SAPM air mass function is not commonly used nowadays, but as it is still in pvlib I think it would still add value to substantiate the docs where the function is found. I'd like to create a PR for these changes but I think I should only go ahead if I get a couple of +1s for this agreeing it'd add value.

Any other suggestions and feedback always more than welcome.

@RDaxini RDaxini changed the title update spectral_factor_sapm update spectral_factor_sapm docs Jul 2, 2024
@kandersolar kandersolar added this to the v0.11.1 milestone Jul 3, 2024
@kandersolar kandersolar added the GSoC Contributions related to Google Summer of Code. label Jul 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation GSoC Contributions related to Google Summer of Code.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants