Create function to calculate average photon energy #2140

RDaxini · 2024-07-20T20:42:11Z

Closes Create calculate_avg_photon_energy function #2135
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.

docs: https://pvlib-python--2140.org.readthedocs.build/en/2140/reference/generated/pvlib.spectrum.average_photon_energy.html

pvlib/spectrum/mismatch.py

update docstring

fix docs typesetting

add checks in function for negative irradiance and invalid data type add tests for these checks update docs maths typesetting

still trying to typeset the units without using / / between multiple length units

trying unicode superscript

pvlib/spectrum/__init__.py

pvlib/spectrum/mismatch.py

pvlib/tests/test_spectrum.py

pvlib/spectrum/mismatch.py

Co-authored-by: Kevin Anderson <kevin.anderso@gmail.com>

echedey-ls · 2024-08-06T20:27:26Z

In general terms of the API, is it reasonable to add an optional parameter for the wavelength (pandas object index)? For example, polars users are understandably afraid of indexes https://docs.pola.rs/user-guide/migration/pandas/#polars-does-not-have-a-multi-indexindex .

Other pandas alternatives that state performance improvements may also have indexes, so it may be worth to check against the index attribute in the input object instead of the exact datatype of pandas. I'm not really sure since I would expect these alternative to patch the datatype.

My idea is to apply a pattern like this (edit: forget about the normalize parameter):

pvlib-python/pvlib/spectrum/response.py

Line 184 in 72185cb

def qe_to_sr(qe, wavelength=None, normalize=False):

Nevertheless, I would understand opinions against this suggestion. The code may be a little more messy doing so.

Otherwise, I think this PR is well packed.

kandersolar · 2024-08-08T14:25:14Z

My 2 cents: the idea of making design decisions around non-pandas dataframes deserves more thorough discussion than what it will get in this PR. In this particular case, I think it should be easy to add that functionality later in a backwards-compatible way, so I think we should keep it simple and stick with the pandas use case for now.

update returns statement, change symbols, suppress runtimewarning for division by zero Co-Authored-By: Kevin Anderson <57452607+kandersolar@users.noreply.github.com>

cwhanse

Maybe include one more test verifying "returns np.nan in the case of 0 Wm⁻²nm⁻¹ spectral irradiance input."

pvlib/spectrum/irradiance.py

add test for return np.nan in case of zero si input

Co-authored-by: Cliff Hansen <cwhanse@sandia.gov>

AdamRJensen

This is awesome, thanks @RDaxini

pvlib/spectrum/irradiance.py

pvlib/tests/spectrum/test_irradiance.py

apple suggestions from code review Co-Authored-By: Adam R. Jensen <39184289+adamrjensen@users.noreply.github.com>

"spectrum" variable --> "spectra" (see pvlib#2150)

kandersolar

A few more comments :)

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

pvlib/spectrum/irradiance.py

pvlib/tests/spectrum/test_mismatch.py

pvlib/spectrum/irradiance.py

pvlib/tests/spectrum/test_irradiance.py

remove unintentional change

apply suggestion from code review Co-Authored-By: Kevin Anderson <57452607+kandersolar@users.noreply.github.com>

sentence correction Co-Authored-By: Kevin Anderson <57452607+kandersolar@users.noreply.github.com>

return series in case of dataframe input, add test to verify. Remove unnecessary spaces from tests

update test for datatype according to suggestion from code review

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

Co-authored-by: Kevin Anderson <kevin.anderso@gmail.com>

kandersolar · 2024-08-14T18:03:05Z

Thanks @RDaxini and reviewers!

RDaxini · 2024-08-14T19:41:58Z

Thanks all:)

RDaxini added 3 commits July 20, 2024 21:33

create

4cf9961

Update spectrum.rst

a9d8dd9

Update test_spectrum.py

513d708

msevillanob reviewed Jul 30, 2024

View reviewed changes

pvlib/spectrum/mismatch.py Outdated Show resolved Hide resolved

RDaxini mentioned this pull request Aug 1, 2024

"spectral irradiance" variable defintion/standardisation suggestion #2150

Open

RDaxini added 6 commits August 1, 2024 21:47

Update mismatch.py

f376d59

update docstring

Update mismatch.py

5eb7c13

Update mismatch.py

3420a92

fix docs typesetting

Update mismatch.py

c2049ee

docs, tests

afb06f4

docs, data checks, tests

928c38c

add checks in function for negative irradiance and invalid data type add tests for these checks update docs maths typesetting

RDaxini marked this pull request as ready for review August 2, 2024 09:55

RDaxini changed the title ~~Create function to calculate average photon energy (draft)~~ Create function to calculate average photon energy Aug 2, 2024

RDaxini added 2 commits August 2, 2024 12:10

Update mismatch.py

d63298a

still trying to typeset the units without using / / between multiple length units

Update mismatch.py

3e46831

trying unicode superscript

kandersolar added the enhancement label Aug 5, 2024

kandersolar added this to the v0.11.1 milestone Aug 5, 2024

kandersolar reviewed Aug 5, 2024

View reviewed changes

RDaxini and others added 2 commits August 5, 2024 14:10

Apply suggestions from code review

2f4b17e

Co-authored-by: Kevin Anderson <kevin.anderso@gmail.com>

remove comments, inverse fraction

5a66414

RDaxini mentioned this pull request Aug 5, 2024

Google Summer of Code project summary: Implementing new spectral corrections in pvlib #2065

Closed

RDaxini added 3 commits August 5, 2024 16:23

remove comment

ec5bc6c

Merge remote-tracking branch 'upstream/main' into calc_ape

2534ddd

Update irradiance.py

6cb9689

RDaxini and others added 4 commits August 8, 2024 15:52

Merge remote-tracking branch 'upstream/main' into calc_ape

c9b4107

Update test_irradiance.py

1720d7d

Update test_irradiance.py

a869f83

Update irradiance.py

af63875

update returns statement, change symbols, suppress runtimewarning for division by zero Co-Authored-By: Kevin Anderson <57452607+kandersolar@users.noreply.github.com>

RDaxini added 4 commits August 8, 2024 16:38

mixed up my lambdas and gammas:(

43ae7d3

change variable name spectral_irr -> spectrum

c2c373d

update variable name in docstring + error messages

698d9d7

Update irradiance.py

e9919f5

cwhanse approved these changes Aug 12, 2024

View reviewed changes

pvlib/spectrum/irradiance.py Outdated Show resolved Hide resolved

pvlib/spectrum/irradiance.py Outdated Show resolved Hide resolved

pvlib/spectrum/irradiance.py Outdated Show resolved Hide resolved

pvlib/spectrum/irradiance.py Outdated Show resolved Hide resolved

RDaxini and others added 3 commits August 12, 2024 20:07

Update test_irradiance.py

458bf16

add test for return np.nan in case of zero si input

Apply suggestions from code review

ecba3eb

Co-authored-by: Cliff Hansen <cwhanse@sandia.gov>

Update irradiance.py

0b95307

RDaxini mentioned this pull request Aug 13, 2024

Add "ape" to variables_style_rules.csv #2164

Merged

5 tasks

Update v0.11.1.rst

39fe12c

AdamRJensen approved these changes Aug 14, 2024

View reviewed changes

pvlib/spectrum/irradiance.py Outdated Show resolved Hide resolved

pvlib/spectrum/irradiance.py Outdated Show resolved Hide resolved

pvlib/spectrum/irradiance.py Outdated Show resolved Hide resolved

pvlib/tests/spectrum/test_irradiance.py Outdated Show resolved Hide resolved

RDaxini and others added 3 commits August 14, 2024 11:56

Update irradiance.py

112747e

apple suggestions from code review Co-Authored-By: Adam R. Jensen <39184289+adamrjensen@users.noreply.github.com>

Update irradiance.py

ddc70c5

"spectrum" variable --> "spectra" (see pvlib#2150)

Update test_irradiance.py

a8e72d8

"spectrum" variable --> "spectra" (see pvlib#2150)

kandersolar reviewed Aug 14, 2024

View reviewed changes

RDaxini and others added 5 commits August 14, 2024 17:58

Update test_mismatch.py

80bf690

remove unintentional change

Update v0.11.1.rst

1bafc90

apply suggestion from code review Co-Authored-By: Kevin Anderson <57452607+kandersolar@users.noreply.github.com>

Update irradiance.py

6a21228

sentence correction Co-Authored-By: Kevin Anderson <57452607+kandersolar@users.noreply.github.com>

update output datatype and associated tests

c224e05

return series in case of dataframe input, add test to verify. Remove unnecessary spaces from tests

Update test_irradiance.py

ace5a65

update test for datatype according to suggestion from code review

kandersolar approved these changes Aug 14, 2024

View reviewed changes

docs/sphinx/source/whatsnew/v0.11.1.rst Outdated Show resolved Hide resolved

Update docs/sphinx/source/whatsnew/v0.11.1.rst

072eeeb

Co-authored-by: Kevin Anderson <kevin.anderso@gmail.com>

kandersolar merged commit cd9cb9a into pvlib:main Aug 14, 2024
30 checks passed

RDaxini deleted the calc_ape branch August 14, 2024 18:40

RDaxini restored the calc_ape branch August 14, 2024 18:40

RDaxini deleted the calc_ape branch August 14, 2024 18:40

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Create function to calculate average photon energy #2140

Create function to calculate average photon energy #2140

RDaxini commented Jul 20, 2024 •

edited

Loading

echedey-ls commented Aug 6, 2024 •

edited

Loading

kandersolar commented Aug 8, 2024

cwhanse left a comment

AdamRJensen left a comment

kandersolar left a comment

kandersolar commented Aug 14, 2024

RDaxini commented Aug 14, 2024

Create function to calculate average photon energy #2140

Create function to calculate average photon energy #2140

Conversation

RDaxini commented Jul 20, 2024 • edited Loading

echedey-ls commented Aug 6, 2024 • edited Loading

kandersolar commented Aug 8, 2024

cwhanse left a comment

Choose a reason for hiding this comment

AdamRJensen left a comment

Choose a reason for hiding this comment

kandersolar left a comment

Choose a reason for hiding this comment

kandersolar commented Aug 14, 2024

RDaxini commented Aug 14, 2024

RDaxini commented Jul 20, 2024 •

edited

Loading

echedey-ls commented Aug 6, 2024 •

edited

Loading