Skip to content

Make i_x and i_xx SAPM parameters optional #2433

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 8 commits into from
Apr 23, 2025

Conversation

kandersolar
Copy link
Member

  • Closes Consider making i_x and i_xx SAPM parameters optional #2402
  • 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.

@kandersolar kandersolar added this to the v0.12.1 milestone Apr 10, 2025
@kandersolar
Copy link
Member Author

kandersolar commented Apr 10, 2025

todo: IXO and IXXO were missed

edit: now done

Comment on lines +19 to +20
:py:func:`pvlib.pvsystem.sapm` directly and through
:py:class:`~pvlib.pvsystem.PVSystem` and :py:class:`~pvlib.modelchain.ModelChain`.
Copy link
Contributor

Choose a reason for hiding this comment

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

Not super important, but is there a reason for ~ on the class reference but not the function reference?

Copy link
Member Author

Choose a reason for hiding this comment

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

The thought was to make it clear that the change applies to both the function and class layers. If it rendered as just sapm, it would be visually ambiguous whether it was pvlib.pvsystem.sapm or pvlib.pvsystem.PVSystem.sapm.

RDaxini added a commit to RDaxini/pvlib-python that referenced this pull request Apr 22, 2025
Copy link
Contributor

@RDaxini RDaxini left a comment

Choose a reason for hiding this comment

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

LGTM

@kandersolar kandersolar merged commit 47b8df2 into pvlib:main Apr 23, 2025
30 checks passed
@kandersolar kandersolar deleted the sapm-ixx branch April 23, 2025 19:21
kandersolar pushed a commit that referenced this pull request Apr 23, 2025
…apm` (#2435)

* Update pvsystem.py

* Update v0.12.1.rst

* Update pvsystem.py

* Update pvsystem.py

* list non-required param instead, units, formatting

* Update pvlib/pvsystem.py

Co-authored-by: Cliff Hansen <[email protected]>

* update param list (excl. param removed by #2433)

* add blank line for bullet list rendering

* separate C param

---------

Co-authored-by: Cliff Hansen <[email protected]>
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 making i_x and i_xx SAPM parameters optional
2 participants