Skip to content

Commit 4b113ab

Browse files
MaxJacksoncwhanse
andauthored
Clarify output variable mapping in calcparams_ functions (#2405)
* DOC: Clarify output variable mapping in calcparams_desoto, calcparams_cec, and calcparams_pvsyst * Clean up unhelpful comment Co-authored-by: Cliff Hansen <[email protected]> * Resolve nNsVth Naming Co-authored-by: Cliff Hansen <[email protected]> * Clean up var naming comment Co-authored-by: Cliff Hansen <[email protected]> * fix: Address linting issues * docs: Add contributor/contribution to whatsnew --------- Co-authored-by: Cliff Hansen <[email protected]>
1 parent 72ced3c commit 4b113ab

File tree

2 files changed

+7
-1
lines changed

2 files changed

+7
-1
lines changed

docs/sphinx/source/whatsnew/v0.11.3.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,8 @@ Documentation
3838
* Fix Procedural and Object Oriented simulation examples having slightly different results, in :ref:`introtutorial`. (:issue:`2366`, :pull:`2367`)
3939
* Restructure the user guide with subsections (:issue:`2302`, :pull:`2310`)
4040
* Add references for :py:func:`pvlib.snow.loss_townsend`. (:issue:`2383`, :pull:`2384`)
41-
* Add :term:`ghi_clear` to the :ref:`nomenclature` page (:issue:`2272`, :pull`2397`)
41+
* Add :term:`ghi_clear` to the :ref:`nomenclature` page (:issue:`2272`, :pull:`2397`)
42+
* Add output variable naming clarifaction to :py:func:`pvlib.pvsystem.calcparams_desoto` and :py:func:`pvlib.pvsystem.calcparams_pvsyst` (:issue:`716`, :pull:`2405`)
4243

4344
Testing
4445
~~~~~~~
@@ -78,3 +79,4 @@ Contributors
7879
* Kevin Anderson (:ghuser:`kandersolar`)
7980
* Echedey Luis (:ghuser:`echedey-ls`)
8081
* Mark Campanelli (:ghuser:`markcampanelli`)
82+
* Max Jackson (:ghuser:`MaxJackson`)

pvlib/pvsystem.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1709,6 +1709,8 @@ def calcparams_desoto(effective_irradiance, temp_cell,
17091709
Rs = R_s
17101710

17111711
numeric_args = (effective_irradiance, temp_cell)
1712+
# IL: photocurrent, I0: saturation_current, Rs: resistance_series,
1713+
# Rsh: resistance_shunt
17121714
out = (IL, I0, Rs, Rsh, nNsVth)
17131715

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

19771979
numeric_args = (effective_irradiance, temp_cell)
1980+
# IL: photocurrent, I0: saturation_current, Rs: resistance_series,
1981+
# Rsh: resistance_shunt
19781982
out = (IL, I0, Rs, Rsh, nNsVth)
19791983

19801984
if all(map(np.isscalar, numeric_args)):

0 commit comments

Comments
 (0)