Skip to content

Commit

Permalink
Fix more broken links (#1960)
Browse files Browse the repository at this point in the history
* 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 <kevin.anderso@gmail.com>
  • Loading branch information
cwhanse and kandersolar committed Feb 8, 2024
1 parent 8efe6c4 commit 26acf8a
Show file tree
Hide file tree
Showing 9 changed files with 29 additions and 60 deletions.
10 changes: 5 additions & 5 deletions docs/sphinx/source/index.rst
Expand Up @@ -84,12 +84,12 @@ Additional pvlib python publications include:

* J. S. Stein, “The photovoltaic performance modeling
collaborative (PVPMC),” in Photovoltaic Specialists Conference, 2012.
* R.W. Andrews, J.S. Stein, C. Hansen, and D. Riley, Introduction
to the open source pvlib for python photovoltaic system
modelling package,” in 40th IEEE Photovoltaic Specialist
Conference, 2014.
* R. W. Andrews, J. S. Stein, C. Hansen and D. Riley, "Introduction to the open
source PV LIB for python Photovoltaic system modelling package,"
2014 IEEE 40th Photovoltaic Specialist Conference (PVSC), Denver, CO, USA,
2014, pp. 0170-0174, https://doi.org/10.1109/PVSC.2014.6925501
(`paper
<http://energy.sandia.gov/wp/wp-content/gallery/uploads/PV_LIB_Python_final_SAND2014-18444C.pdf>`__)
<https://www.osti.gov/servlets/purl/1241774>`__)
* W.F. Holmgren, R.W. Andrews, A.T. Lorenzo, and J.S. Stein,
“PVLIB Python 2015,” in 42nd Photovoltaic Specialists Conference, 2015.
(`paper
Expand Down
16 changes: 1 addition & 15 deletions docs/sphinx/source/user_guide/clearsky.rst
Expand Up @@ -344,15 +344,6 @@ Validation

See [Ine02]_, [Ren12]_.

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


.. _simplified_solis:

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

See [Ine16]_.

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

.. _detect_clearsky:

Detect Clearsky
Expand Down
6 changes: 1 addition & 5 deletions docs/sphinx/source/user_guide/installation.rst
Expand Up @@ -40,10 +40,6 @@ for pvlib, including Pandas, NumPy, and SciPy.
#. **Install** the Anaconda Python distribution available at
`Anaconda.com <https://www.anaconda.com/download/>`_.

See `What is Anaconda? <https://www.anaconda.com/what-is-anaconda/>`_
and the `Anaconda Documentation <https://docs.anaconda.com/anaconda/>`_
for more information.

You can now install pvlib-python by one of the methods below.


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

Expand Down
13 changes: 3 additions & 10 deletions docs/sphinx/source/user_guide/timetimezones.rst
Expand Up @@ -246,13 +246,6 @@ You cannot localize a native Python date object.
pvlib-specific functionality
----------------------------

.. note::

This section applies to pvlib >= 0.3. Version 0.2 of pvlib used a
``Location`` object's ``tz`` attribute to auto-magically correct for
some time zone issues. This behavior was counter-intuitive to many
users and was removed in version 0.3.

How does this general functionality interact with pvlib? Perhaps the two
most common places to get tripped up with time and time zone issues in
solar power analysis occur during data import and solar position
Expand Down Expand Up @@ -315,9 +308,9 @@ DataFrame's index since the index has been localized.
ax.set_ylabel('(degrees)');
`According to the US Navy
<http://aa.usno.navy.mil/rstt/onedaytable?ID=AA&year=1997&month=1&day=1&state=AK&place=sand+point>`_,
on January 1, 1997 at Sand Point, Alaska, sunrise was at 10:09 am, solar
noon was at 1:46 pm, and sunset was at 5:23 pm. This is consistent with
<https://aa.usno.navy.mil/data/RS_OneDay>`_,
on January 1, 2024 at Sand Point, Alaska (55.34N, -160.5W), sunrise was at 10:09 am, solar
noon was at 1:46 pm, and sunset was at 5:22 pm. This is consistent with
the data plotted above (and depressing).

Solar position (assumed UTC)
Expand Down
10 changes: 3 additions & 7 deletions docs/sphinx/source/user_guide/variables_style_rules.rst
Expand Up @@ -15,15 +15,11 @@ There is a convention on consistent variable names throughout the library:
For a definition and further explanation on the variables, common symbols and units refer to the following sources:


* `Reference Variable List by PVPMC <https://pvpmc.sandia.gov/resources-and-events/variable-list/>`_
* `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.
* Explanation of Solar irradiation and solar geometry by `SoDa Service <http://www.soda-pro.com/home>`_

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

.. note:: These further references might not use the same terminology as *pvlib*. But the physical process referred to is the same.
2 changes: 1 addition & 1 deletion docs/sphinx/source/whatsnew/v0.10.4.rst
Expand Up @@ -21,7 +21,7 @@ Testing

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

Requirements
Expand Down
15 changes: 7 additions & 8 deletions pvlib/clearsky.py
Expand Up @@ -25,11 +25,11 @@ def ineichen(apparent_zenith, airmass_absolute, linke_turbidity,
Implements the Ineichen and Perez clear sky model for global
horizontal irradiance (GHI), direct normal irradiance (DNI), and
calculates the clear-sky diffuse horizontal (DHI) component as the
difference between GHI and DNI*cos(zenith) as presented in [1, 2]. A
difference between GHI and DNI*cos(zenith) as presented in [1]_ [2]_. A
report on clear sky models found the Ineichen/Perez model to have
excellent performance with a minimal input data set [3].
excellent performance with a minimal input data set [3]_.
Default values for monthly Linke turbidity provided by SoDa [4, 5].
Default values for monthly Linke turbidity provided by SoDa [4]_, [5]_.
Parameters
-----------
Expand Down Expand Up @@ -80,12 +80,12 @@ def ineichen(apparent_zenith, airmass_absolute, linke_turbidity,
Clear Sky Models: Implementation and Analysis", Sandia National
Laboratories, SAND2012-2389, 2012.
.. [4] http://www.soda-is.com/eng/services/climat_free_eng.php#c5 (obtained
July 17, 2012).
.. [4] https://www.soda-pro.com/help/general-knowledge/linke-turbidity-factor
(accessed February 2, 2024).
.. [5] J. Remund, et. al., "Worldwide Linke Turbidity Information", Proc.
ISES Solar World Congress, June 2003. Goteborg, Sweden.
'''
''' # noqa: E501

# ghi is calculated using either the equations in [1] by setting
# perez_enhancement=False (default behavior) or using the model
Expand Down Expand Up @@ -993,8 +993,7 @@ def bird(zenith, airmass_relative, aod380, aod500, precipitable_water,
.. [3] `NREL Bird Clear Sky Model <http://rredc.nrel.gov/solar/models/
clearsky/>`_
.. [4] `SERI/TR-642-761 <http://rredc.nrel.gov/solar/pubs/pdfs/
tr-642-761.pdf>`_
.. [4] `SERI/TR-642-761 <https://www.nrel.gov/docs/legosti/old/761.pdf>`_
.. [5] `Error Reports <http://rredc.nrel.gov/solar/models/clearsky/
error_reports.html>`_
Expand Down
2 changes: 1 addition & 1 deletion pvlib/irradiance.py
Expand Up @@ -602,7 +602,7 @@ def get_ground_diffuse(surface_tilt, ghi, albedo=.25, surface_type=None):
and
http://en.wikipedia.org/wiki/Albedo
and
https://doi.org/10.1175/1520-0469(1972)029<0959:AOTSS>2.0.CO;2
:doi:`10.1175/1520-0469(1972)029<0959:AOTSS>2.0.CO;2`
'''

if surface_type is not None:
Expand Down
15 changes: 7 additions & 8 deletions pvlib/solarposition.py
Expand Up @@ -132,7 +132,7 @@ def get_solarposition(time, latitude, longitude,
def spa_c(time, latitude, longitude, pressure=101325, altitude=0,
temperature=12, delta_t=67.0,
raw_spa_output=False):
"""
r"""
Calculate the solar position using the C implementation of the NREL
SPA code.
Expand Down Expand Up @@ -161,7 +161,7 @@ def spa_c(time, latitude, longitude, pressure=101325, altitude=0,
Temperature in C
delta_t : float, default 67.0
Difference between terrestrial time and UT1.
USNO has previous values and predictions.
USNO has previous values and predictions [3]_.
raw_spa_output : bool, default False
If true, returns the raw SPA output.
Expand All @@ -177,17 +177,16 @@ def spa_c(time, latitude, longitude, pressure=101325, altitude=0,
References
----------
.. [1] NREL SPA reference:
http://rredc.nrel.gov/solar/codesandalgorithms/spa/
NREL SPA C files: https://midcdmz.nrel.gov/spa/
.. [1] NREL SPA reference: https://midcdmz.nrel.gov/spa/
Note: The ``timezone`` field in the SPA C files is replaced with
``time_zone`` to avoid a nameclash with the function ``__timezone`` that is
redefined by Python>=3.5. This issue is
`Python bug 24643 <https://bugs.python.org/issue24643>`_.
.. [2] Delta T:
https://en.wikipedia.org/wiki/%CE%94T_(timekeeping)
.. [2] Delta T: https://en.wikipedia.org/wiki/%CE%94T_(timekeeping)
.. [3] USNO delta T: https://maia.usno.navy.mil/products/deltaT
See also
--------
Expand Down Expand Up @@ -344,7 +343,7 @@ def spa_python(time, latitude, longitude,
2007.
.. [3] USNO delta T:
http://www.usno.navy.mil/USNO/earth-orientation/eo-products/long-term
https://maia.usno.navy.mil/products/deltaT
See also
--------
Expand Down

0 comments on commit 26acf8a

Please sign in to comment.