Skip to content

Commit 26acf8a

Browse files
cwhansekandersolar
andauthored
Fix more broken links (#1960)
* remove outdated links * remake USN link * repair reference to 2014 paper * remove old links * remove extinct links * fix NREL link * remove v0.2 note * whatsnew * fix links * fix link to Anaconda * use `noqa` for docstring with long url --------- Co-authored-by: Kevin Anderson <[email protected]>
1 parent 8efe6c4 commit 26acf8a

File tree

9 files changed

+29
-60
lines changed

9 files changed

+29
-60
lines changed

docs/sphinx/source/index.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -84,12 +84,12 @@ Additional pvlib python publications include:
8484

8585
* J. S. Stein, “The photovoltaic performance modeling
8686
collaborative (PVPMC),” in Photovoltaic Specialists Conference, 2012.
87-
* R.W. Andrews, J.S. Stein, C. Hansen, and D. Riley, Introduction
88-
to the open source pvlib for python photovoltaic system
89-
modelling package,” in 40th IEEE Photovoltaic Specialist
90-
Conference, 2014.
87+
* R. W. Andrews, J. S. Stein, C. Hansen and D. Riley, "Introduction to the open
88+
source PV LIB for python Photovoltaic system modelling package,"
89+
2014 IEEE 40th Photovoltaic Specialist Conference (PVSC), Denver, CO, USA,
90+
2014, pp. 0170-0174, https://doi.org/10.1109/PVSC.2014.6925501
9191
(`paper
92-
<http://energy.sandia.gov/wp/wp-content/gallery/uploads/PV_LIB_Python_final_SAND2014-18444C.pdf>`__)
92+
<https://www.osti.gov/servlets/purl/1241774>`__)
9393
* W.F. Holmgren, R.W. Andrews, A.T. Lorenzo, and J.S. Stein,
9494
“PVLIB Python 2015,” in 42nd Photovoltaic Specialists Conference, 2015.
9595
(`paper

docs/sphinx/source/user_guide/clearsky.rst

Lines changed: 1 addition & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -344,15 +344,6 @@ Validation
344344

345345
See [Ine02]_, [Ren12]_.
346346

347-
Will Holmgren compared pvlib's Ineichen model and climatological
348-
turbidity to `SoDa's McClear service
349-
<http://www.soda-pro.com/web-services/radiation/cams-mcclear>`_ in
350-
Arizona. Here are links to an
351-
`ipynb notebook
352-
<https://forecasting.energy.arizona.edu/media/ineichen_vs_mcclear.ipynb>`_
353-
and its `html rendering
354-
<https://forecasting.energy.arizona.edu/media/ineichen_vs_mcclear.html>`_.
355-
356347

357348
.. _simplified_solis:
358349

@@ -370,9 +361,7 @@ Aerosol and precipitable water data
370361
There are a number of sources for aerosol and precipitable water data
371362
of varying accuracy, global coverage, and temporal resolution.
372363
Ground based aerosol data can be obtained from
373-
`Aeronet <http://aeronet.gsfc.nasa.gov>`_. Precipitable water can be obtained
374-
from `radiosondes <http://weather.uwyo.edu/upperair/sounding.html>`_,
375-
`ESRL GPS-MET <http://gpsmet.noaa.gov/cgi-bin/gnuplots/rti.cgi>`_, or
364+
`Aeronet <http://aeronet.gsfc.nasa.gov>`_. Precipitable water can be
376365
derived from surface relative humidity using functions such as
377366
:py:func:`pvlib.atmosphere.gueymard94_pw`.
378367
Numerous gridded products from satellites, weather models, and climate models
@@ -577,9 +566,6 @@ Validation
577566

578567
See [Ine16]_.
579568

580-
We encourage users to compare the pvlib implementation to Ineichen's
581-
`Excel tool <http://www.unige.ch/energie/fr/equipe/ineichen/solis-tool/>`_.
582-
583569
.. _detect_clearsky:
584570

585571
Detect Clearsky

docs/sphinx/source/user_guide/installation.rst

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -40,10 +40,6 @@ for pvlib, including Pandas, NumPy, and SciPy.
4040
#. **Install** the Anaconda Python distribution available at
4141
`Anaconda.com <https://www.anaconda.com/download/>`_.
4242

43-
See `What is Anaconda? <https://www.anaconda.com/what-is-anaconda/>`_
44-
and the `Anaconda Documentation <https://docs.anaconda.com/anaconda/>`_
45-
for more information.
46-
4743
You can now install pvlib-python by one of the methods below.
4844

4945

@@ -56,7 +52,7 @@ Users may install pvlib-python using either the
5652
`conda <https://conda.io/docs/>`_ or `pip <https://pip.pypa.io>`_
5753
package manager. We recommend that most users install pvlib-python
5854
using the conda package manager in the
59-
`Anaconda Python distribution <https://www.anaconda.com/what-is-anaconda/>`_.
55+
Anaconda python distribution.
6056
To install the most recent stable release of pvlib-python in a
6157
non-editable way, use one of the following commands to install pvlib-python::
6258

docs/sphinx/source/user_guide/timetimezones.rst

Lines changed: 3 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -246,13 +246,6 @@ You cannot localize a native Python date object.
246246
pvlib-specific functionality
247247
----------------------------
248248

249-
.. note::
250-
251-
This section applies to pvlib >= 0.3. Version 0.2 of pvlib used a
252-
``Location`` object's ``tz`` attribute to auto-magically correct for
253-
some time zone issues. This behavior was counter-intuitive to many
254-
users and was removed in version 0.3.
255-
256249
How does this general functionality interact with pvlib? Perhaps the two
257250
most common places to get tripped up with time and time zone issues in
258251
solar power analysis occur during data import and solar position
@@ -315,9 +308,9 @@ DataFrame's index since the index has been localized.
315308
ax.set_ylabel('(degrees)');
316309
317310
`According to the US Navy
318-
<http://aa.usno.navy.mil/rstt/onedaytable?ID=AA&year=1997&month=1&day=1&state=AK&place=sand+point>`_,
319-
on January 1, 1997 at Sand Point, Alaska, sunrise was at 10:09 am, solar
320-
noon was at 1:46 pm, and sunset was at 5:23 pm. This is consistent with
311+
<https://aa.usno.navy.mil/data/RS_OneDay>`_,
312+
on January 1, 2024 at Sand Point, Alaska (55.34N, -160.5W), sunrise was at 10:09 am, solar
313+
noon was at 1:46 pm, and sunset was at 5:22 pm. This is consistent with
321314
the data plotted above (and depressing).
322315

323316
Solar position (assumed UTC)

docs/sphinx/source/user_guide/variables_style_rules.rst

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -15,15 +15,11 @@ There is a convention on consistent variable names throughout the library:
1515
For a definition and further explanation on the variables, common symbols and units refer to the following sources:
1616

1717

18-
* `Reference Variable List by PVPMC <https://pvpmc.sandia.gov/resources-and-events/variable-list/>`_
1918
* `IEC 61724-1:2017 -- Photovoltaic system performance - Part 1: Monitoring <https://webstore.iec.ch/publication/33622>`_ section: 3 -- Terms and definitions; the Indian Standard referencing the withdrawn earlier global IEC standard IEC 61724:1998 is available online: `IS/IEC 61724 (1998) <https://archive.org/details/gov.in.is.iec.61724.1998>`_ and can provide relevant contents.
2019
* Explanation of Solar irradiation and solar geometry by `SoDa Service <http://www.soda-pro.com/home>`_
2120

22-
* `Acronyms, Terminology and Units <http://www.soda-pro.com/help/general/acronyms-terminology-and-units>`_
23-
* `Plane orientations and radiation components <http://www.soda-pro.com/help/general/plane-orientations-and-radiation-components>`_
24-
* `Time references <http://www.soda-pro.com/help/general/time-references>`_
25-
* `Units and conversion tool <http://www.soda-is.com/eng/education/units.html>`_
26-
* `Terminology: definitions of the main quantities. <http://www.soda-is.com/eng/education/terminology.html>`_
27-
* `Acronyms in solar radiation <http://www.soda-is.com/eng/education/acronymes.html>`_ (more extensive list)
21+
* `Acronyms, Terminology and Units <https://www.soda-pro.com/help/general/acronyms-terminology-and-units>`_
22+
* `Plane orientations and radiation components <https://www.soda-pro.com/help/general/plane-orientations-and-radiation-components>`_
23+
* `Time references <https://www.soda-pro.com/help/general/time-references>`_
2824

2925
.. note:: These further references might not use the same terminology as *pvlib*. But the physical process referred to is the same.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Testing
2121

2222
Documentation
2323
~~~~~~~~~~~~~
24-
* Fixed broken URLs in various docstrings. (:pull:`1957`)
24+
* Fixed broken URLs in various places. (:pull:`1957`, :pull:`1960`)
2525
* Clarified documentation for :py:func:`~pvlib.irradiance.get_ground_diffuse`. (:pull:`1883`)
2626

2727
Requirements

pvlib/clearsky.py

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -25,11 +25,11 @@ def ineichen(apparent_zenith, airmass_absolute, linke_turbidity,
2525
Implements the Ineichen and Perez clear sky model for global
2626
horizontal irradiance (GHI), direct normal irradiance (DNI), and
2727
calculates the clear-sky diffuse horizontal (DHI) component as the
28-
difference between GHI and DNI*cos(zenith) as presented in [1, 2]. A
28+
difference between GHI and DNI*cos(zenith) as presented in [1]_ [2]_. A
2929
report on clear sky models found the Ineichen/Perez model to have
30-
excellent performance with a minimal input data set [3].
30+
excellent performance with a minimal input data set [3]_.
3131
32-
Default values for monthly Linke turbidity provided by SoDa [4, 5].
32+
Default values for monthly Linke turbidity provided by SoDa [4]_, [5]_.
3333
3434
Parameters
3535
-----------
@@ -80,12 +80,12 @@ def ineichen(apparent_zenith, airmass_absolute, linke_turbidity,
8080
Clear Sky Models: Implementation and Analysis", Sandia National
8181
Laboratories, SAND2012-2389, 2012.
8282
83-
.. [4] http://www.soda-is.com/eng/services/climat_free_eng.php#c5 (obtained
84-
July 17, 2012).
83+
.. [4] https://www.soda-pro.com/help/general-knowledge/linke-turbidity-factor
84+
(accessed February 2, 2024).
8585
8686
.. [5] J. Remund, et. al., "Worldwide Linke Turbidity Information", Proc.
8787
ISES Solar World Congress, June 2003. Goteborg, Sweden.
88-
'''
88+
''' # noqa: E501
8989

9090
# ghi is calculated using either the equations in [1] by setting
9191
# perez_enhancement=False (default behavior) or using the model
@@ -993,8 +993,7 @@ def bird(zenith, airmass_relative, aod380, aod500, precipitable_water,
993993
.. [3] `NREL Bird Clear Sky Model <http://rredc.nrel.gov/solar/models/
994994
clearsky/>`_
995995
996-
.. [4] `SERI/TR-642-761 <http://rredc.nrel.gov/solar/pubs/pdfs/
997-
tr-642-761.pdf>`_
996+
.. [4] `SERI/TR-642-761 <https://www.nrel.gov/docs/legosti/old/761.pdf>`_
998997
999998
.. [5] `Error Reports <http://rredc.nrel.gov/solar/models/clearsky/
1000999
error_reports.html>`_

pvlib/irradiance.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -602,7 +602,7 @@ def get_ground_diffuse(surface_tilt, ghi, albedo=.25, surface_type=None):
602602
and
603603
http://en.wikipedia.org/wiki/Albedo
604604
and
605-
https://doi.org/10.1175/1520-0469(1972)029<0959:AOTSS>2.0.CO;2
605+
:doi:`10.1175/1520-0469(1972)029<0959:AOTSS>2.0.CO;2`
606606
'''
607607

608608
if surface_type is not None:

pvlib/solarposition.py

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,7 @@ def get_solarposition(time, latitude, longitude,
132132
def spa_c(time, latitude, longitude, pressure=101325, altitude=0,
133133
temperature=12, delta_t=67.0,
134134
raw_spa_output=False):
135-
"""
135+
r"""
136136
Calculate the solar position using the C implementation of the NREL
137137
SPA code.
138138
@@ -161,7 +161,7 @@ def spa_c(time, latitude, longitude, pressure=101325, altitude=0,
161161
Temperature in C
162162
delta_t : float, default 67.0
163163
Difference between terrestrial time and UT1.
164-
USNO has previous values and predictions.
164+
USNO has previous values and predictions [3]_.
165165
raw_spa_output : bool, default False
166166
If true, returns the raw SPA output.
167167
@@ -177,17 +177,16 @@ def spa_c(time, latitude, longitude, pressure=101325, altitude=0,
177177
178178
References
179179
----------
180-
.. [1] NREL SPA reference:
181-
http://rredc.nrel.gov/solar/codesandalgorithms/spa/
182-
NREL SPA C files: https://midcdmz.nrel.gov/spa/
180+
.. [1] NREL SPA reference: https://midcdmz.nrel.gov/spa/
183181
184182
Note: The ``timezone`` field in the SPA C files is replaced with
185183
``time_zone`` to avoid a nameclash with the function ``__timezone`` that is
186184
redefined by Python>=3.5. This issue is
187185
`Python bug 24643 <https://bugs.python.org/issue24643>`_.
188186
189-
.. [2] Delta T:
190-
https://en.wikipedia.org/wiki/%CE%94T_(timekeeping)
187+
.. [2] Delta T: https://en.wikipedia.org/wiki/%CE%94T_(timekeeping)
188+
189+
.. [3] USNO delta T: https://maia.usno.navy.mil/products/deltaT
191190
192191
See also
193192
--------
@@ -344,7 +343,7 @@ def spa_python(time, latitude, longitude,
344343
2007.
345344
346345
.. [3] USNO delta T:
347-
http://www.usno.navy.mil/USNO/earth-orientation/eo-products/long-term
346+
https://maia.usno.navy.mil/products/deltaT
348347
349348
See also
350349
--------

0 commit comments

Comments
 (0)