Skip to content

documentation fixes #632

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.

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 12 commits into from
Dec 10, 2018
2 changes: 1 addition & 1 deletion docs/sphinx/source/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ calculations.
solarposition.equation_of_time_spencer71
solarposition.equation_of_time_pvcdrom
solarposition.hour_angle
solarposition.sunrise_sunset_transit_geometric
solarposition.sun_rise_set_transit_geometric


Clear sky
Expand Down
6 changes: 4 additions & 2 deletions docs/sphinx/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -313,8 +313,10 @@ def setup(app):
# Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping = {
'python': ('https://docs.python.org/3.7/', None),
'pandas': ('http://pandas.pydata.org/pandas-docs/stable/', None),
'numpy': ('http://docs.scipy.org/doc/numpy/', None),
'pandas': ('https://pandas.pydata.org/pandas-docs/stable/', None),
'numpy': ('https://docs.scipy.org/doc/numpy/', None),
}

nbsphinx_allow_errors = True

ipython_warning_is_error = False
1 change: 1 addition & 0 deletions docs/sphinx/source/forecasts.rst
Original file line number Diff line number Diff line change
Expand Up @@ -414,6 +414,7 @@ Use the NDFD, among others, for forecasts at all time horizons.
The NDFD is available for the United States.

.. ipython:: python
:okexcept:

model = NDFD()
data = model.get_processed_data(latitude, longitude, start, end)
Expand Down
2 changes: 0 additions & 2 deletions docs/sphinx/source/modelchain.rst
Original file line number Diff line number Diff line change
Expand Up @@ -376,9 +376,7 @@ function if you wanted to.
def pvusa(poa_global, wind_speed, temp_air, a, b, c, d):
"""
Calculates system power according to the PVUSA equation

P = I * (a + b*I + c*W + d*T)

where
P is the output power,
I is the plane of array irradiance,
Expand Down
2 changes: 1 addition & 1 deletion docs/sphinx/source/timetimezones.rst
Original file line number Diff line number Diff line change
Expand Up @@ -272,7 +272,7 @@ Let's first examine how pvlib handles time when it imports a TMY3 file.
# some gymnastics to find the example file
pvlib_abspath = os.path.dirname(os.path.abspath(inspect.getfile(pvlib)))
file_abspath = os.path.join(pvlib_abspath, 'data', '703165TY.csv')
tmy3_data, tmy3_metadata = pvlib.tmy.readtmy3(file_abspath)
tmy3_data, tmy3_metadata = pvlib.iotools.read_tmy3(file_abspath)

tmy3_metadata

Expand Down
23 changes: 14 additions & 9 deletions docs/sphinx/source/whatsnew/v0.6.1.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.. _whatsnew_0601:

v0.6.1 (EST November, 2018)
v0.6.1 (EST December, 2018)
---------------------------

This is a minor release. We recommend all users of v0.6.0 upgrade to this
Expand All @@ -19,11 +19,14 @@ API Changes
they will be removed in v0.7. Use the new :py:func:`pvlib.iotools.read_tmy2`
and :py:func:`pvlib.iotools.read_tmy3` instead. (:issue:`261`)
* Added keyword argument ``horizon`` to :func:`~pvlib.solarposition.pyephem`
and :func:`~pvlib.solarposition.calc_time` with default value ``'+0:00'``
* Changed key names for `components` returned from :py:func:`pvlib.clearsky.detect_clearsky`
* Changed function name from :py:func:`pvlib.solarposition.get_rise_set_transit` (deprecated)
to :py:func:`pvlib.solarposition.sun_rise_set_transit_spa. `sun_rise_set_transit_spa`
requires time input to be localized to the specified latitude/longitude. (:issue:`316')
and :func:`~pvlib.solarposition.calc_time` with default value ``'+0:00'``.
(:issue:`588`)
* Changed key names for `components` returned from
:py:func:`pvlib.clearsky.detect_clearsky`. (:issue:`596`)
* Changed function name from `pvlib.solarposition.get_rise_set_transit`
(deprecated) to :py:func:`pvlib.solarposition.sun_rise_set_transit_spa.
`sun_rise_set_transit_spa` requires time input to be localized to the
specified latitude/longitude. (:issue:`316`)


Enhancements
Expand All @@ -43,18 +46,20 @@ Enhancements
isobaric values and modeled wind speed instead of inferring from gust.
(:issue:`604`)
* Change :py:func:`pvlib.pvsystem.sapm_spectral_loss` to avoid numpy warning.
* Add warning message when :py:func:`pvlib.spa` is reloaded.
* Add warning message when :py:func:`pvlib.spa` is reloaded. (:issue:`401`)
* Add option for :py:func:`pvlib.irradiance.disc` to use relative airmass
by supplying `pressure=None`. (:issue:`449`)


Bug fixes
~~~~~~~~~
* Fix when building documentation using Matplotlib 3.0 or greater.
* `~pvlib.spa.calculate_deltat`: Fix constant coefficient of the polynomial expression for years >= 1860
and < 1900, fix year 2050 which was returning 0.
* `~pvlib.spa.calculate_deltat`: Fix constant coefficient of the polynomial
expression for years >= 1860 and < 1900, fix year 2050 which was
returning 0. (:issue:`600`)
* Fix and improve :func:`~pvlib.solarposition.hour_angle` (:issue:`598`)
* Fix error in :func:`pvlib.clearsky.detect_clearsky` (:issue:`506`)
* Fix documentation errors when using IPython >= 7.0.
* Fix error in :func:`pvlib.modelchain.ModelChain.infer_spectral_model` (:issue:`619`)


Expand Down
5 changes: 3 additions & 2 deletions pvlib/iotools/midc.py
Original file line number Diff line number Diff line change
Expand Up @@ -185,8 +185,9 @@ def read_midc_raw_data_from_nrel(site, start, end):
Notes
-----
Requests spanning an instrumentation change will yield an error. See the
MIDC raw data api page here_ for more details and considerations.
.. _here: https://midcdmz.nrel.gov/apps/data_api_doc.pl?_idtextlist
MIDC raw data api page
`here <https://midcdmz.nrel.gov/apps/data_api_doc.pl?_idtextlist>`_
for more details and considerations.
"""
args = {'site': site,
'begin': start.strftime('%Y%m%d'),
Expand Down
2 changes: 1 addition & 1 deletion pvlib/solarposition.py
Original file line number Diff line number Diff line change
Expand Up @@ -387,7 +387,7 @@ def sun_rise_set_transit_spa(times, latitude, longitude, how='numpy',
using times.year and times.month from pandas.DatetimeIndex.
For most simulations specifing delta_t is sufficient.
Difference between terrestrial time and UT1.
*Note: delta_t = None will break code using nrel_numba,
delta_t = None will break code using nrel_numba,
this will be fixed in a future version.
By default, use USNO historical data and predictions
how : str, optional, default 'numpy'
Expand Down
2 changes: 1 addition & 1 deletion pvlib/tmy.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,5 @@
readtmy2 = deprecated('0.6.1', alternative='iotools.read_tmy2',
name='readtmy2', removal='0.7')(read_tmy2)

readtmy3 = deprecated('0.6.1', alternative='iotools.read_tmy2',
readtmy3 = deprecated('0.6.1', alternative='iotools.read_tmy3',
name='readtmy3', removal='0.7')(read_tmy3)