8000 Adopt `dni_clear` variable name for clearsky DNI by RDaxini · Pull Request #2274 · pvlib/pvlib-python · GitHub
[go: up one dir, main page]

Skip to content

Adopt dni_clear variable name for clearsky DNI #2274

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 19 commits into from
Dec 10, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
Prev Previous commit
Next Next commit
Apply suggestions from code review
Co-authored-by: Echedey Luis <80125792+echedey-ls@users.noreply.github.com>
  • Loading branch information
RDaxini and echedey-ls authored Dec 5, 2024
commit a115f185c17bbb6f6d5b4458de603ed779341f49
3 changes: 2 additions & 1 deletion docs/sphinx/source/whatsnew/v0.11.2.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@ v0.11.2 (Anticipated December, 2024)

Deprecations
~~~~~~~~~~~~
* Deprecated terms `dni_clearsky` and `clearsky_dni`, replaced with `dni_clear`
* Deprecated terms ``dni_clearsky`` and ``clearsky_dni``, replaced with ``dni_clear``.
Affected functions are :py:func:`~pvlib.irradiance.dirindex` and :py:func:`~pvlib.irradiance.dni`.
(:issue:`2272`, :pull:`2274`)


Expand Down
4 changes: 2 additions & 2 deletions pvlib/irradiance.py
74E6
Original file line number Diff line number Diff line change
Expand Up @@ -3649,7 +3649,7 @@ def dni(ghi, dhi, zenith, dni_clear=None, clearsky_tolerance=1.1,
Clearsky direct normal irradiance.

clearsky_tolerance : float, default 1.1
If `dni_clear` is given this parameter can be used to allow a
If ``dni_clear`` is given this parameter can be used to allow a
tolerance by how much the calculated DNI value can be greater than
the clearsky value before it is identified as an unreasonable value.

Expand All @@ -3662,7 +3662,7 @@ def dni(ghi, dhi, zenith, dni_clear=None, clearsky_tolerance=1.1,
'zenith_threshold_for_clearsky_limit' and smaller the
'zenith_threshold_for_zero_dni' that are greater than the clearsky DNI
(times allowed tolerance) will be corrected. Only applies if
`dni_clear` is not None.
``dni_clear`` is not None.

Returns
-------
Expand Down
Loading
0