Add reference for Gueymard 93 relative airmass model by cwhanse · Pull Request #2424 · pvlib/pvlib-python

cwhanse · 2025-03-31T15:08:03Z

Closes Reference for Gueymard 1993 air mass equation incorrect #2390
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.

RDaxini

Since we're working on the references, let's add some underscores? This should hyperlink the numbers to their respective citation in the list at the bottom of the page.
(I can only suggest changes to lines that were changed or next to those that were changes, but I think we should update the entire page in this PR)

RDaxini · 2025-03-31T15:18:36Z

        * 'kastenyoung1989' (default) - See reference [3] -
          requires apparent sun zenith
-        * 'gueymard1993' - See reference [4] -
+        * 'gueymard1993' - See references [4] and [9] -


Suggested change

* 'gueymard1993' - See references [4] and [9] -

* 'gueymard1993' - See references [4]_ and [9]_ -

RDaxini · 2025-03-31T15:18:45Z

    other models use true (not refraction-adjusted) zenith angle. Apparent
    zenith angles should be calculated at sea level.

+    Comparison among several models is reported in [10].


Suggested change

Comparison among several models is reported in [10].

Comparison among several models is reported in [10]_.

RDaxini · 2025-03-31T15:19:07Z

@@ -153,7 +153,7 @@ def get_relative_airmass(zenith, model='kastenyoung1989'):
          requires true sun zenith
        * 'kastenyoung1989' (default) - See reference [3] -


Suggested change

* 'kastenyoung1989' (default) - See reference [3] -

* 'kastenyoung1989' (default) - See reference [3]_ -

RDaxini · 2025-03-31T15:19:39Z

-        * 'gueymard1993' - See reference [4] -
+        * 'gueymard1993' - See references [4] and [9] -
          requires apparent sun zenith
        * 'young1994' - See reference [5] -


Suggested change

* 'young1994' - See reference [5] -

* 'young1994' - See reference [5]_ -

RDaxini · 2025-03-31T17:14:32Z

+        * 'kasten1966' - See [1]_ - requires apparent sun zenith
+        * 'youngirvine1967' - See [2]_ - requires true sun zenith
+        * 'kastenyoung1989' (default) - See [3]_ - requires apparent sun zenith
+        * 'gueymard1993' - See [4]_, [9]_ - requires apparent sun zenith
+        * 'young1994' - See [5]_ - requires true sun zenith
+        * 'pickering2002' - See [6]_ - requires apparent sun zenith
+        * 'gueymard2003' - See [7]_, [8]_ - requires apparent sun zenith


Nitpicking, but should we adjust the order? [9] -> [5] and so on. I missed this earlier, just noticed it now.
(reference list would need to change accordingly)

Suggested change

* 'kasten1966' - See [1]_ - requires apparent sun zenith

* 'youngirvine1967' - See [2]_ - requires true sun zenith

* 'kastenyoung1989' (default) - See [3]_ - requires apparent sun zenith

* 'gueymard1993' - See [4]_, [9]_ - requires apparent sun zenith

* 'young1994' - See [5]_ - requires true sun zenith

* 'pickering2002' - See [6]_ - requires apparent sun zenith

* 'gueymard2003' - See [7]_, [8]_ - requires apparent sun zenith

* 'kasten1966' - See [1]_ - requires apparent sun zenith

* 'youngirvine1967' - See [2]_ - requires true sun zenith

* 'kastenyoung1989' (default) - See [3]_ - requires apparent sun zenith

* 'gueymard1993' - See [4]_, [5]_ - requires apparent sun zenith

* 'young1994' - See [6]_ - requires true sun zenith

* 'pickering2002' - See [7]_ - requires apparent sun zenith

* 'gueymard2003' - See [8]_, [9]_ - requires apparent sun zenith

echedey-ls

LGTM!

echedey-ls · 2025-03-31T22:12:01Z

+
+Documentation
+~~~~~~~~~~~~~
+* Add a supporting reference to :py:func:`pvlib.atmosphere.get_relative_airmass` (:issue:`2390`, :pull:`2424`)


Suggested change

* Add a supporting reference to :py:func:`pvlib.atmosphere.get_relative_airmass` (:issue:`2390`, :pull:`2424`)

* Add a supporting bibliographic reference to model ``gueymard1993`` in

:py:func:`pvlib.atmosphere.get_relative_airmass` (:issue:`2390`, :pull:`2424`)

Clarification for users out of context.

I thought just "reference" was okay without "bibliographic". Adding the model ``gueymard1993`` in seems reasonable though

Agreed. I sometimes think of code references, but given this piece of description is in the Docs section, you are completely right.

AdamRJensen · 2025-04-02T12:29:14Z

-    .. [9] Matthew J. Reno, Clifford W. Hansen and Joshua S. Stein, "Global
+    .. [10] Matthew J. Reno, Clifford W. Hansen and Joshua S. Stein, "Global
       Horizontal Irradiance Clear Sky Models: Implementation and Analysis"
       Sandia Report, (2012).


Suggested change

Sandia Report, (2012).

Sandia Report, (2012).

:doi:`10.2172/1039404`

I can't add DOIs for the other references but here they are:
1: 11681/5671
2: 10.1086/110366
3: 10.1364/AO.28.004735
4: 10.1016/0038-092X(93)90074-X

cwhanse · 2025-04-02T14:48:09Z

Thanks @RDaxini @AdamRJensen your comments motivated me to update the formatting to the IEEE convention.

RDaxini · 2025-04-02T14:58:55Z

    .. [2] A. T. Young and W. M. Irvine, "Multicolor Photoelectric
       Photometry of the Brighter Planets," The Astronomical Journal, vol.
       72, pp. 945-950, 1967.
+       :doi:`10.2172/110366`


hmm... this doi did not work for me. Try:

Suggested change

:doi:`10.2172/110366`

:doi:`10.1086/110366`

AdamRJensen · 2025-04-02T15:01:02Z


-    .. [7] Keith A. Pickering. "The Ancient Star Catalog". DIO 12:1, 20,
+    .. [7] Keith A. Pickering, "The Southern Limits of the Ancient Star Catalog
+       and the Commentary fo Hipparchos," DIO, vol. 12, pp. 3-27, Sept. 2002.


fo needs to be of (for some reason it won't let me suggest it)

Could consider adding the url: http://dioi.org/jc01.pdf

RDaxini

LGTM

kandersolar · 2025-04-04T15:46:15Z

Thanks everyone for the reviews!

cwhanse added 2 commits March 31, 2025 09:02

add reference

ae3fcff

whatsnew

f733c3a

cwhanse added the documentation label Mar 31, 2025

cwhanse added this to the v0.12.1 milestone Mar 31, 2025

RDaxini reviewed Mar 31, 2025

View reviewed changes

underscores

58aa1a8

RDaxini reviewed Mar 31, 2025

View reviewed changes

reference order

f99bf6f

echedey-ls approved these changes Mar 31, 2025

View reviewed changes

AdamRJensen approved these changes Apr 2, 2025

View reviewed changes

improve references

141bfe7

fix errors

411f89a

RDaxini reviewed Apr 2, 2025

View reviewed changes

AdamRJensen reviewed Apr 2, 2025

View reviewed changes

add url

654dcfb

RDaxini approved these changes Apr 2, 2025

View reviewed changes

kandersolar merged commit 0812192 into pvlib:main Apr 4, 2025
30 checks passed

kandersolar modified the milestones: v0.12.1, v0.13.0 Jun 7, 2025

	* 'gueymard1993' - See references [4] and [9] -
	* 'gueymard1993' - See references [4]_ and [9]_ -

	Comparison among several models is reported in [10].
	Comparison among several models is reported in [10]_.

		@@ -153,7 +153,7 @@ def get_relative_airmass(zenith, model='kastenyoung1989'):
		requires true sun zenith
		* 'kastenyoung1989' (default) - See reference [3] -

	* 'young1994' - See reference [5] -
	* 'young1994' - See reference [5]_ -

	* Add a supporting reference to :py:func:`pvlib.atmosphere.get_relative_airmass` (:issue:`2390`, :pull:`2424`)
	* Add a supporting bibliographic reference to model ``gueymard1993`` in
	:py:func:`pvlib.atmosphere.get_relative_airmass` (:issue:`2390`, :pull:`2424`)

	Sandia Report, (2012).
	Sandia Report, (2012).
	:doi:`10.2172/1039404`

Conversation

cwhanse commented Mar 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

RDaxini left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

RDaxini Mar 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

echedey-ls left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

cwhanse commented Apr 2, 2025

Uh oh!

RDaxini Apr 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

RDaxini left a comment

Choose a reason for hiding this comment

Uh oh!

kandersolar commented Apr 4, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

cwhanse commented Mar 31, 2025 •

edited

Loading

RDaxini Mar 31, 2025 •

edited

Loading

RDaxini Apr 2, 2025 •

edited

Loading