Skip to content

Minor documentation error in description of return value of pvlib.solarposition.ephemeris #2153

@kandersolar

Description

@kandersolar

The docstring for pvlib.solarposition.ephemeris incorrectly describes azimuth as "the complement of the apparent zenith angle":

* apparent_elevation : apparent sun elevation accounting for
atmospheric refraction.
* elevation : actual elevation (not accounting for refraction)
of the sun in decimal degrees, 0 = on horizon.
The complement of the zenith angle.
* azimuth : Azimuth of the sun in decimal degrees East of North.
This is the complement of the apparent zenith angle.
* apparent_zenith : apparent sun zenith accounting for atmospheric
refraction.
* zenith : Solar zenith angle
* solar_time : Solar time in decimal hours (solar noon is 12.00).

I'm guessing this was an editing error while swapping the order of entries in that list. To fix the error, the sentence in question ("This is the complement of the apparent zenith angle.") should be moved to the description of apparent_elevation.

I suggest we hold off on fixing this issue so that it remains available for a new contributor to fix during the upcoming pvlib user's group meeting in Copenhagen.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions