diff --git a/docs/sphinx/source/conf.py b/docs/sphinx/source/conf.py index 4c4164e23a..959f395179 100644 --- a/docs/sphinx/source/conf.py +++ b/docs/sphinx/source/conf.py @@ -271,7 +271,8 @@ def setup(app): 'GH'), 'wiki': ('https://github.com/pvlib/pvlib-python/wiki/%s', 'wiki '), - 'doi': ('http://dx.doi.org/%s', 'DOI: ')} + 'doi': ('http://dx.doi.org/%s', 'DOI: '), + 'ghuser': ('https://github.com/%s', '@')} # -- Options for manual page output --------------------------------------- diff --git a/docs/sphinx/source/whatsnew/v0.6.0.rst b/docs/sphinx/source/whatsnew/v0.6.0.rst index b26f02cb57..d0197c8bd6 100644 --- a/docs/sphinx/source/whatsnew/v0.6.0.rst +++ b/docs/sphinx/source/whatsnew/v0.6.0.rst @@ -1,7 +1,11 @@ .. _whatsnew_0600: -v0.6.0 (___, 2018) ---------------------- +v0.6.0 (September 17, 2018) +--------------------------- + +This is a major release and contains a large number of API changes, new +features, and bug fixes. Users should carefully read the changelog below +before upgrading. **Python 2.7 support will end on June 1, 2019**. Releases made after this date will require Python 3. (:issue:`501`) @@ -13,31 +17,31 @@ API Changes that can calculate a quantity using multiple algorithms now start with the prefix ``get_``. For example, ``relativeairmass`` can calculate airmass using one of many ``model`` arguments. Its name has been changed - to ``get_relative_airmass``. The old function names remain in this + to :func:`~pvlib.atmosphere.get_relative_airmass`. The old function names remain in this release, but will emit a ``PVLibDeprecationWarning`` when called. The - old functions will be removed in the 0.7 release. Functions composed + old functions will be removed in the v0.7 release. Functions composed of multiple words jammed together have been renamed with underscores separating the words (see above). Each change is detailed below. (:issue:`427`) -* Deprecated relativeairmass. relativeairmass will be removed in 0.7. - Use the new get_relative_airmass instead. (:issue:`427`) -* Deprecated absoluteairmass. absoluteairmass will be removed in 0.7. - Use the new get_absolute_airmass instead. (:issue:`427`) -* Deprecated irradiance.globalinplane. globalinplane will be removed in 0.7. - Use the new irradiance.poa_components instead. (:issue:`427`) -* Added irradiance.poa_components. Function is the same as the now-deprecated - irradiance.globalinplane, but adds 'poa_sky_diffuse' and - 'poa_ground_diffuse' to the output. (:issue:`427`) -* Deprecated irradiance.extraradiation. Use irradiance.get_extra_radiation - instead. irradiance.extraradiation will be removed in 0.7. (:issue:`427`) -* Deprecated irradiance.grounddiffuse. Use irradiance.get_ground_diffuse - instead. irradiance.grounddiffuse will be removed in 0.7. (:issue:`427`) -* Added irradiance.get_poa_sky_diffuse. (:issue:`427`) -* Deprecated irradiance.total_irrad. Use irradiance.get_total_poa_irradiance - instead. irradiance.total_irrad will be removed in 0.7. (:issue:`427`) -* Removed 'klutcher' from get_sky_diffuse/total_irrad. This misspelling was +* Deprecated ``relativeairmass``; it will be removed in v0.7. + Use the new :func:`~pvlib.atmosphere.get_relative_airmass` instead. (:issue:`427`) +* Deprecated ``absoluteairmass``; it will be removed in v0.7. + Use the new :func:`~pvlib.atmosphere.get_absolute_airmass` instead. (:issue:`427`) +* Deprecated ``irradiance.globalinplane``; it will be removed in v0.7. + Use the new :func:`~pvlib.irradiance.poa_components` instead. (:issue:`427`) +* Added :func:`~pvlib.irradiance.poa_components`. Function is the same as the now-deprecated + ``irradiance.globalinplane``, but adds ``'poa_sky_diffuse'`` and + ``'poa_ground_diffuse'`` to the output. (:issue:`427`) +* Deprecated ``irradiance.extraradiation``; it will be removed in v0.7. + Use :func:`pvlib.irradiance.get_extra_radiation` instead. (:issue:`427`) +* Deprecated ``irradiance.grounddiffuse``; it will be removed in v0.7. Use + :func:`~pvlib.irradiance.get_ground_diffuse` instead. (:issue:`427`) +* Added :func:`~pvlib.irradiance.get_poa_sky_diffuse`. (:issue:`427`) +* Deprecated ``irradiance.total_irrad``; it will be removed in v0.7. Use + :func:`~pvlib.irradiance.get_total_poa_irradiance` instead. (:issue:`427`) +* Removed ``'klutcher'`` from ``get_sky_diffuse``/``total_irrad``. This misspelling was deprecated long ago but never removed. (:issue:`97`) -* pvsystem.calcparams_desoto now requires arguments for each module model +* :func:`~pvlib.pvsystem.calcparams_desoto` now requires arguments for each module model parameter. (:issue:`462`) * Add losses_parameters attribute to PVSystem objects and remove the kwargs support from PVSystem.pvwatts_losses. Enables custom losses specification @@ -75,7 +79,7 @@ Enhancements * Clarify arguments ``Egref`` and ``dEgdT`` for :func:`~pvlib.pvsystem.calcparams_desoto` (:issue:`462`) * Add pvsystem.calcparams_pvsyst to compute values for the single diode equation - using the PVsyst v6 model (:issue:'470') + using the PVsyst v6 model (:issue:`470`) * Extend :func:`~pvlib.pvsystem.singlediode` with an additional keyword argument ``method`` in ``('lambertw', 'newton', 'brentq')``, default is ``'lambertw'``, to select a method to solve the single diode equation for points on the IV @@ -196,13 +200,24 @@ Testing * Improve test_atmosphere.py. (:issue:`158`) * Add LGTM.com integration. (:issue:`554`) * Add SticklerCI integration. +* Add codecov integration. Contributors ~~~~~~~~~~~~ -* Will Holmgren -* Yu Cao -* Cliff Hansen -* Mark Mikofski -* Alan Mathew -* Xavier Rene-Corail +* Will Holmgren (:ghuser:`wholmgren`) +* Yu Cao (:ghuser:`tsaoyu`) +* Cliff Hansen (:ghuser:`cwhanse`) +* Mark Mikofski (:ghuser:`mikofski`) +* Alan Mathew (:ghuser:`alamathe1`) +* Xavier Rene-Corail (:ghuser:`xcorail`) +* Anton Driesse (:ghuser:`adriesse`) +* Mark Campanelli (:ghuser:`thunderfish24`) +* Cedric Leroy (:ghuser:`cedricleroy`) +* Jessica Forbess (:ghuser:`jforbess`) +* Jeff Newmiller (:ghuser:`jdnewmil`) +* :ghuser:`josricha` +* Marc A. Anoma (:ghuser:`anomam`) +* William C Grisaitis (:ghuser:`grisaitis`) +* Karel De Brabandere (:ghuser:`kdebrab`) +* :ghuser:`tadatoshi` \ No newline at end of file