Skip to content

Commit f80068c

Browse files
authored
Minor improvements to sphinx docs (#1248)
* various sphinx edits * remove stray whitespace
1 parent d5d8ffa commit f80068c

File tree

4 files changed

+9
-10
lines changed

4 files changed

+9
-10
lines changed

docs/sphinx/source/api.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,6 @@ calculations.
8989
solarposition.equation_of_time_spencer71
9090
solarposition.equation_of_time_pvcdrom
9191
solarposition.hour_angle
92-
solarposition.sun_rise_set_transit_geometric
9392

9493

9594
Clear sky

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,7 @@ Enhancements
146146
implemented in SAM. (:pull:`1177`, :pull:`1195`)
147147
* Added :py:func:`~pvlib.ivtools.sdm.pvsyst_temperature_coeff` to calculate
148148
the temperature coefficient of power for the pvsyst module model.
149-
(:pull:`1190`)
149+
(:pull:`1190`)
150150
* :py:func:`~pvlib.irradiance.get_total_irradiance` and
151151
:py:func:`~pvlib.irradiance.get_sky_diffuse` now fill in ``airmass``
152152
if required and not provided. These functions now raise a ``ValueError``

pvlib/iam.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -228,7 +228,7 @@ def martin_ruiz(aoi, a_r=0.16):
228228
.. math::
229229
230230
IAM = \frac{1 - \exp(-\cos(\frac{aoi}{a_r}))}
231-
{1 - \exp(\frac{-1}{a_r}}
231+
{1 - \exp(\frac{-1}{a_r})}
232232
233233
which is presented as :math:`AL(\alpha) = 1 - IAM` in equation 4 of [1]_,
234234
with :math:`\alpha` representing the angle of incidence AOI. Thus IAM = 1

pvlib/irradiance.py

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1470,7 +1470,7 @@ def dirint(ghi, solar_zenith, times, pressure=101325., use_delta_kt_prime=True,
14701470
model.
14711471
14721472
Implements the modified DISC model known as "DIRINT" introduced in
1473-
[1]. DIRINT predicts direct normal irradiance (DNI) from measured
1473+
[1]_. DIRINT predicts direct normal irradiance (DNI) from measured
14741474
global horizontal irradiance (GHI). DIRINT improves upon the DISC
14751475
model by using time-series GHI data and dew point temperature
14761476
information. The effectiveness of the DIRINT model improves with
@@ -1712,11 +1712,11 @@ def dirindex(ghi, ghi_clearsky, dni_clearsky, zenith, times, pressure=101325.,
17121712
"""
17131713
Determine DNI from GHI using the DIRINDEX model.
17141714
1715-
The DIRINDEX model [1] modifies the DIRINT model implemented in
1716-
:py:func:``pvlib.irradiance.dirint`` by taking into account information
1715+
The DIRINDEX model [1]_ modifies the DIRINT model implemented in
1716+
:py:func:`pvlib.irradiance.dirint` by taking into account information
17171717
from a clear sky model. It is recommended that ``ghi_clearsky`` be
17181718
calculated using the Ineichen clear sky model
1719-
:py:func:``pvlib.clearsky.ineichen`` with ``perez_enhancement=True``.
1719+
:py:func:`pvlib.clearsky.ineichen` with ``perez_enhancement=True``.
17201720
17211721
The pvlib implementation limits the clearness index to 1.
17221722
@@ -1868,8 +1868,8 @@ def gti_dirint(poa_global, aoi, solar_zenith, solar_azimuth, times,
18681868
albedo : numeric, default 0.25
18691869
Surface albedo
18701870
1871-
model : String, default 'isotropic'
1872-
Irradiance model.
1871+
model : String, default 'perez'
1872+
Irradiance model. See :py:func:`get_sky_diffuse` for allowed values.
18731873
18741874
model_perez : String, default 'allsitescomposite1990'
18751875
Used only if model='perez'. See :py:func:`perez`.
@@ -1884,7 +1884,7 @@ def gti_dirint(poa_global, aoi, solar_zenith, solar_azimuth, times,
18841884
18851885
Returns
18861886
-------
1887-
data : OrderedDict or DataFrame
1887+
data : DataFrame
18881888
Contains the following keys/columns:
18891889
18901890
* ``ghi``: the modeled global horizontal irradiance in W/m^2.

0 commit comments

Comments
 (0)