Skip to content

Clarify output variable mapping in calcparams_ functions #2405

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.

Sign up for GitHub

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 6 commits into from
Mar 11, 2025
Merged

Clarify output variable mapping in calcparams_ functions #2405

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
10db5ad
DOC: Clarify output variable mapping in calcparams_desoto, calcparams…
MaxJackson Mar 11, 2025
67d429e
Clean up unhelpful comment
MaxJackson Mar 11, 2025
4e4b3e6
Resolve nNsVth Naming
MaxJackson Mar 11, 2025
13d0a5d
Clean up var naming comment
MaxJackson Mar 11, 2025
35bafce
fix: Address linting issues
MaxJackson Mar 11, 2025
d7928bb
docs: Add contributor/contribution to whatsnew
MaxJackson Mar 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion docs/sphinx/source/whatsnew/v0.11.3.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,8 @@ Documentation
* Fix Procedural and Object Oriented simulation examples having slightly different results, in :ref:`introtutorial`. (:issue:`2366`, :pull:`2367`)
* Restructure the user guide with subsections (:issue:`2302`, :pull:`2310`)
* Add references for :py:func:`pvlib.snow.loss_townsend`. (:issue:`2383`, :pull:`2384`)
* Add :term:`ghi_clear` to the :ref:`nomenclature` page (:issue:`2272`, :pull`2397`)
* Add :term:`ghi_clear` to the :ref:`nomenclature` page (:issue:`2272`, :pull:`2397`)
* Add output variable naming clarifaction to :py:func:`pvlib.pvsystem.calcparams_desoto` and :py:func:`pvlib.pvsystem.calcparams_pvsyst` (:issue:`716`, :pull:`2405`)

Testing
~~~~~~~
Expand Down Expand Up @@ -78,3 +79,4 @@ Contributors
* Kevin Anderson (:ghuser:`kandersolar`)
* Echedey Luis (:ghuser:`echedey-ls`)
* Mark Campanelli (:ghuser:`markcampanelli`)
* Max Jackson (:ghuser:`MaxJackson`)
4 changes: 4 additions & 0 deletions pvlib/pvsystem.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1709,6 +1709,8 @@ def calcparams_desoto(effective_irradiance, temp_cell,
Rs = R_s

numeric_args = (effective_irradiance, temp_cell)
# IL: photocurrent, I0: saturation_current, Rs: resistance_series,
# Rsh: resistance_shunt
out = (IL, I0, Rs, Rsh, nNsVth)

if all(map(np.isscalar, numeric_args)):
Expand Down Expand Up @@ -1975,6 +1977,8 @@ def calcparams_pvsyst(effective_irradiance, temp_cell,
Rs = R_s

numeric_args = (effective_irradiance, temp_cell)
# IL: photocurrent, I0: saturation_current, Rs: resistance_series,
# Rsh: resistance_shunt
out = (IL, I0, Rs, Rsh, nNsVth)

if all(map(np.isscalar, numeric_args)):
Expand Down