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

Update spectral_factor_sapm docs #2116

Merged
merged 14 commits into from
Jul 3, 2024
Merged

Conversation

RDaxini
Copy link
Contributor

@RDaxini RDaxini commented Jul 3, 2024

  • Closes update spectral_factor_sapm docs #2115
  • I am familiar with the contributing guidelines
  • 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.

Summary of changes so far:

  • Hyperlinked reference to sapm()
  • Added references
  • Added model equation
  • Added details about the model

Docs here

@RDaxini RDaxini marked this pull request as ready for review July 3, 2024 13:31
@kandersolar kandersolar added this to the v0.11.1 milestone Jul 3, 2024
Copy link
Member

@kandersolar kandersolar left a comment

Choose a reason for hiding this comment

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

Great improvement!

pvlib/spectrum/mismatch.py Outdated Show resolved Hide resolved
pvlib/spectrum/mismatch.py Outdated Show resolved Hide resolved
pvlib/spectrum/mismatch.py Show resolved Hide resolved
pvlib/spectrum/mismatch.py Outdated Show resolved Hide resolved
RDaxini and others added 5 commits July 3, 2024 14:55
Co-authored-by: Kevin Anderson <kevin.anderso@gmail.com>
Co-authored-by: Kevin Anderson <kevin.anderso@gmail.com>
Co-authored-by: Kevin Anderson <kevin.anderso@gmail.com>
@RDaxini
Copy link
Contributor Author

RDaxini commented Jul 3, 2024

Great improvement!

@kandersolar Thanks!

I have made the revisions according to the suggestions so far. Thanks for the review

Copy link
Member

@kandersolar kandersolar left a comment

Choose a reason for hiding this comment

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

LGTM. I'll leave this open for a few days in case others wish to review as well.

@kandersolar kandersolar added the GSoC Contributions related to Google Summer of Code. label Jul 3, 2024
pvlib/spectrum/mismatch.py Outdated Show resolved Hide resolved
pvlib/spectrum/mismatch.py Outdated Show resolved Hide resolved
pvlib/spectrum/mismatch.py Outdated Show resolved Hide resolved
RDaxini and others added 3 commits July 3, 2024 20:32
Co-authored-by: Cliff Hansen <cwhanse@sandia.gov>
Co-authored-by: Cliff Hansen <cwhanse@sandia.gov>
Co-authored-by: Cliff Hansen <cwhanse@sandia.gov>
@RDaxini
Copy link
Contributor Author

RDaxini commented Jul 3, 2024

Thanks for reviewing @cwhanse
I agree with and have applied your suggested changes

@cwhanse
Copy link
Member

cwhanse commented Jul 3, 2024

LGTM, I think we can do without the whatsnew note for this addition.

@cwhanse cwhanse merged commit 99619e8 into pvlib:main Jul 3, 2024
30 checks passed
@RDaxini RDaxini deleted the update_sapm_scf branch July 3, 2024 20:05
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 this pull request may close these issues.

update spectral_factor_sapm docs
3 participants