Rename eta_m and eta_m_ref to module_efficiency #1218
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mikofski
approved these changes
May 7, 2021
Member
Author
|
@wholmgren ok to merge? |
wholmgren
reviewed
May 7, 2021
pvlib/temperature.py
Outdated
|
|
||
| def pvsyst_cell(poa_global, temp_air, wind_speed=1.0, u_c=29.0, u_v=0.0, | ||
| eta_m=0.1, alpha_absorption=0.9): | ||
| eta_m=0.1, module_efficiency=0.1, alpha_absorption=0.9): |
Member
There was a problem hiding this comment.
Suggested change
| eta_m=0.1, module_efficiency=0.1, alpha_absorption=0.9): | |
| eta_m=None, module_efficiency=0.1, alpha_absorption=0.9): |
pvlib/temperature.py
Outdated
| :math:`\left[ \frac{\text{W}/\text{m}^2}{\text{C}\ \left( \text{m/s} \right)} \right]` # noQA: E501 | ||
| eta_m : numeric, default 0.1 | ||
| eta_m : numeric, default 0.1 (deprecated, use module_efficiency instead) |
Member
There was a problem hiding this comment.
Suggested change
| eta_m : numeric, default 0.1 (deprecated, use module_efficiency instead) | |
| eta_m : numeric, default None (deprecated, use module_efficiency instead) |
pvlib/temperature.py
Outdated
Comment on lines
382
to
383
| if not module_efficiency: | ||
| module_efficiency = eta_m |
Member
There was a problem hiding this comment.
This doesn't make much sense to me. To get here you'd have to explicitly set module_efficiency=None. Maybe better to just override module_efficiency with eta_m if it's provided.
pvlib/temperature.py
Outdated
Comment on lines
320
to
322
| Module external efficiency as a fraction, i.e., | ||
| :math:`DC\ power / (POA\ irradiance \times module\ area)`. | ||
| Parameter :math:`\eta_{m}` in :eq:`pvsyst`. |
Member
There was a problem hiding this comment.
remove this. pending resolution of comment below, add "If not None, warns of deprecation and overrides module_efficiency"
Member
Author
There was a problem hiding this comment.
I agree with all your suggestions.
wholmgren
approved these changes
May 7, 2021
Member
wholmgren
left a comment
wholmgren
left a comment
There was a problem hiding this comment.
minor doc suggestion otherwise ready to merge.
| * ``ModelChain.times`` | ||
|
|
||
| * The ``eta_m`` parameter for :py:func:`~pvlib.temperature.pvsyst_cell` is | ||
| replaced by the ``module_efficiency`` parameter. |
Member
There was a problem hiding this comment.
Suggested change
| replaced by the ``module_efficiency`` parameter. | |
| replaced by the ``module_efficiency`` parameter. (:issue:`1188`, :pull:`1218`) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Updates entries todocs/sphinx/source/api.rstfor API changes.docs/sphinx/source/whatsnewfor 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`).Deprecates
eta_minpvlib.temperature.pvsyst_celland replaceseta_m_refinpvlib.temperature.noct_samwithmodule_efficiency.