Skip to content

Commit 3e16ba9

Browse files
tongpucwhanse
andauthored
Fix incorrect description of surface_azimuth parameter in get_pvgis_hourly (#1838)
* Fix misleading documentation for surface_azimuth * Add docs change to v0.10.2 * Add docs change to v0.10.2 Co-authored-by: Cliff Hansen <[email protected]> --------- Co-authored-by: Cliff Hansen <[email protected]>
1 parent 5c20c8c commit 3e16ba9

File tree

2 files changed

+8
-5
lines changed

2 files changed

+8
-5
lines changed

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,8 @@ Documentation
3737
(:issue:`1722`, :pull:`1723`)
3838
* Fix and update example in :py:func:`pvlib.pvsystem.retrieve_sam`.
3939
(:issue:`1741`, :pull:`1833`)
40+
* Fix error in :py:func:`pvlib.iotools.get_pvgis_hourly` documentation of `surface_azimuth`.
41+
(:issue:`1724`, :pull:`1838`)
4042

4143
Requirements
4244
~~~~~~~~~~~~
@@ -48,3 +50,4 @@ Contributors
4850
* Abigail Jones (:ghuser:`ajonesr`)
4951
* Taos Transue (:ghuser:`reepoi`)
5052
* NativeSci (:ghuser:`nativesci`)
53+
* Lukas Grossar (:ghuser:`tongpu`)

pvlib/iotools/pvgis.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -77,14 +77,14 @@ def get_pvgis_hourly(latitude, longitude, start=None, end=None,
7777
surface_tilt: float, default: 0
7878
Tilt angle from horizontal plane. Ignored for two-axis tracking.
7979
surface_azimuth: float, default: 180
80-
Orientation (azimuth angle) of the (fixed) plane. Counter-clockwise
81-
from north (north=0, south=180). This is offset 180 degrees from
82-
the convention used by PVGIS. Ignored for tracking systems.
80+
Orientation (azimuth angle) of the (fixed) plane. Clockwise from north
81+
(north=0, east=90, south=180, west=270). This is offset 180 degrees from the
82+
convention used by PVGIS. Ignored for tracking systems.
8383
8484
.. versionchanged:: 0.10.0
8585
The `surface_azimuth` parameter now follows the pvlib convention, which
86-
is counterclockwise from north. However, the convention used by the
87-
PVGIS website and pvlib<=0.9.5 is offset by 180 degrees.
86+
is clockwise from north. However, the convention used by the PVGIS website
87+
and pvlib<=0.9.5 is offset by 180 degrees.
8888
usehorizon: bool, default: True
8989
Include effects of horizon
9090
userhorizon: list of float, default: None

0 commit comments

Comments
 (0)