10000 Minor improvements to sphinx docs by kandersolar · Pull Request #1248 · pvlib/pvlib-python · GitHub
[go: up one dir, main page]
Skip to content

Minor improvements to sphinx docs #1248

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Jun 21, 2021
Merged

Minor improvements to sphinx docs #1248

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
e99ba31
various sphinx edits
kandersolar Mar 13, 2021
565ebde
Merge branch 'master' into irradiance_docs
kandersolar Apr 15, 2021
8b9f542
Merge branch 'master' into irradiance_docs
kandersolar May 12, 2021
8332f05
Merge remote-tracking branch 'upstream/master' into irradiance_docs
kandersolar Jun 13, 2021
1202ef1
remove stray whitespace
kandersolar Jun 13, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion docs/sphinx/source/api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,6 @@ calculations.
solarposition.equation_of_time_spencer71
solarposition.equation_of_time_pvcdrom
solarposition.hour_angle
solarposition.sun_rise_set_transit_geometric
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what's the motivation for removing this function here? Seems to me that it fits the section description.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's also listed in another section (Functions for calculating sunrise, sunset and transit times) and, to split hairs, it calculates times rather than positions. Happy to put it back if you prefer, I don't feel strongly either way.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fair enough!



Clear sky
Expand Down
2 changes: 1 addition & 1 deletion docs/sphinx/source/whatsnew/v0.9.0.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ Enhancements
implemented in SAM. (:pull:`1177`, :pull:`1195`)
* Added :py:func:`~pvlib.ivtools.sdm.pvsyst_temperature_coeff` to calculate
the temperature coefficient of power for the pvsyst module model.
(:pull:`1190`)
(:pull:`1190`)
* :py:func:`~pvlib.irradiance.get_total_irradiance` and
:py:func:`~pvlib.irradiance.get_sky_diffuse` now fill in ``airmass``
if required and not provided. These functions now raise a ``ValueError``
Expand Down
2 changes: 1 addition & 1 deletion pvlib/iam.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -228,7 +228,7 @@ def martin_ruiz(aoi, a_r=0.16):
.. math::

IAM = \frac{1 - \exp(-\cos(\frac{aoi}{a_r}))}
{1 - \exp(\frac{-1}{a_r}}
{1 - \exp(\frac{-1}{a_r})}

which is presented as :math:`AL(\alpha) = 1 - IAM` in equation 4 of [1]_,
with :math:`\alpha` representing the angle of incidence AOI. Thus IAM = 1
Expand Down
14 changes: 7 additions & 7 deletions pvlib/irradiance.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1470,7 +1470,7 @@ def dirint(ghi, solar_zenith, times, pressure=101325., use_delta_kt_prime=True,
model.

Implements the modified DISC model known as "DIRINT" introduced in
[1]. DIRINT predicts direct normal irradiance (DNI) from measured
[1]_. DIRINT predicts direct normal irradiance (DNI) from measured
global horizontal irradiance (GHI). DIRINT improves upon the DISC
model by using time-series GHI data and dew point temperature
information. The effectiveness of the DIRINT model improves with
Expand Down Expand Up @@ -1712,11 +1712,11 @@ def dirindex(ghi, ghi_clearsky, dni_clearsky, zenith, times, pressure=101325.,
"""
Determine DNI from GHI using the DIRINDEX model.

The DIRINDEX model [1] modifies the DIRINT model implemented in
:py:func:``pvlib.irradiance.dirint`` by taking into account information
The DIRINDEX model [1]_ modifies the DIRINT model implemented in
:py:func:`pvlib.irradiance.dirint` by taking into account information
from a clear sky model. It is recommended that ``ghi_clearsky`` be
calculated using the Ineichen clear sky model
:py:func:``pvlib.clearsky.ineichen`` with ``perez_enhancement=True``.
:py:func:`pvlib.clearsky.ineichen` with ``perez_enhancement=True``.

The pvlib implementation limits the clearness index to 1.

Expand Down Expand Up @@ -1868,8 +1868,8 @@ def gti_dirint(poa_global, aoi, solar_zenith, solar_azimuth, times,
albedo : numeric, default 0.25
Surface albedo

model : String, default 'isotropic'
Irradiance model.
model : String, default 'perez'
Irradiance model. See :py:func:`get_sky_diffuse` for allowed values.

model_perez : String, default 'allsitescomposite1990'
Used only if model='perez'. See :py:func:`perez`.
Expand All @@ -1884,7 +1884,7 @@ def gti_dirint(poa_global, aoi, solar_zenith, solar_azimuth, times,

Returns
-------
data : OrderedDict 4A71 or DataFrame
data : DataFrame
Contains the following keys/columns:

* ``ghi``: the modeled global horizontal irradiance in W/m^2.
Expand Down
0