From bdd2b3a719ec23c9f4359347bfdea342a2db3ff0 Mon Sep 17 00:00:00 2001 From: Kevin Anderson Date: Thu, 21 Sep 2023 15:58:37 -0400 Subject: [PATCH] Finalize 0.10.2 (#1868) * 0.10.2 whatsnew cleanup * create v0.10.3 whatsnew * formatting tweaks * remove GH actions workflow for joss-pdf this file was accidentally merged in with #1855 --- .github/workflows/joss-pdf.yml | 26 ------------- docs/sphinx/source/whatsnew.rst | 1 + docs/sphinx/source/whatsnew/v0.10.2.rst | 51 ++++++++++++------------- docs/sphinx/source/whatsnew/v0.10.3.rst | 26 +++++++++++++ 4 files changed, 52 insertions(+), 52 deletions(-) delete mode 100644 .github/workflows/joss-pdf.yml create mode 100644 docs/sphinx/source/whatsnew/v0.10.3.rst diff --git a/.github/workflows/joss-pdf.yml b/.github/workflows/joss-pdf.yml deleted file mode 100644 index fc07838426..0000000000 --- a/.github/workflows/joss-pdf.yml +++ /dev/null @@ -1,26 +0,0 @@ -# temporary job to rebuild the PDF while coauthors review the manuscript. -# TODO: delete before merging this PR - -on: [push] - -jobs: - paper: - runs-on: ubuntu-latest - name: Paper Draft - steps: - - name: Checkout - uses: actions/checkout@v3 - - name: Build draft PDF - uses: openjournals/openjournals-draft-action@master - with: - journal: joss - # This should be the path to the paper within your repo. - paper-path: paper/paper.md - - name: Upload - uses: actions/upload-artifact@v1 - with: - name: paper - # This is the output path where Pandoc will write the compiled - # PDF. Note, this should be the same directory as the input - # paper.md - path: paper/paper.pdf diff --git a/docs/sphinx/source/whatsnew.rst b/docs/sphinx/source/whatsnew.rst index 75831e6a48..1b19f40ec6 100644 --- a/docs/sphinx/source/whatsnew.rst +++ b/docs/sphinx/source/whatsnew.rst @@ -6,6 +6,7 @@ What's New These are new features and improvements of note in each release. +.. include:: whatsnew/v0.10.2.rst .. include:: whatsnew/v0.10.1.rst .. include:: whatsnew/v0.10.0.rst .. include:: whatsnew/v0.9.5.rst diff --git a/docs/sphinx/source/whatsnew/v0.10.2.rst b/docs/sphinx/source/whatsnew/v0.10.2.rst index 96fced5cfe..3b82d98613 100644 --- a/docs/sphinx/source/whatsnew/v0.10.2.rst +++ b/docs/sphinx/source/whatsnew/v0.10.2.rst @@ -1,72 +1,66 @@ .. _whatsnew_01020: -v0.10.2 (Anticipated September, 2023) -------------------------------------- - - -Deprecations -~~~~~~~~~~~~ +v0.10.2 (September 21, 2023) +---------------------------- Enhancements ~~~~~~~~~~~~ * Added .pan/.ond reader function :py:func:`pvlib.iotools.read_panond`. (:issue:`1747`, :pull:`1749`) * Added support for dates to be specified as strings in the iotools get functions: - :py:func:`pvlib.iotools.get_pvgis_hourly`, :py:func:`pvlib.iotools.get_cams`, - :py:func:`pvlib.iotools.get_bsrn`, and :py:func:`pvlib.iotools.read_midc_raw_data_from_nrel`. + :py:func:`~pvlib.iotools.get_pvgis_hourly`, :py:func:`~pvlib.iotools.get_cams`, + :py:func:`~pvlib.iotools.get_bsrn`, and :py:func:`~pvlib.iotools.read_midc_raw_data_from_nrel`. (:pull:`1800`) * Added support for asymmetric limiting angles in :py:func:`pvlib.tracking.singleaxis` - and :py:class:`~pvlib.pvsystem.SingleAxisTrackerMount. (:issue:`1777`, :pull:`1809`, :pull:`1852`) + and :py:class:`~pvlib.pvsystem.SingleAxisTrackerMount`. (:issue:`1777`, :pull:`1809`, :pull:`1852`) * Added option to infer threshold values for :py:func:`pvlib.clearsky.detect_clearsky` (:issue:`1808`, :pull:`1784`) * Added a continuous version of the Erbs diffuse-fraction/decomposition model. :py:func:`pvlib.irradiance.erbs_driesse` (:issue:`1755`, :pull:`1834`) * Added :py:func:`~pvlib.iam.interp` option as AOI losses model in - :py:class:`pvlib.modelchain.ModelChain` and - :py:class:`pvlib.pvsystem.PVSystem`. (:issue:`1742`, :pull:`1832`) + :py:class:`~pvlib.modelchain.ModelChain` and + :py:class:`~pvlib.pvsystem.PVSystem`. (:issue:`1742`, :pull:`1832`) * :py:class:`~pvlib.pvsystem.PVSystem` objects with a single :py:class:`~pvlib.pvsystem.Array` can now be created without wrapping the ``Array`` in a list first. (:issue:`1831`, :pull:`1854`) + Bug fixes ~~~~~~~~~ * :py:func:`~pvlib.iotools.get_psm3` no longer incorrectly returns clear-sky DHI instead of clear-sky GHI when requesting ``ghi_clear``. (:pull:`1819`) -* :py:func:`pvlib.singlediode.bishop88` with `method='newton'` no longer - crashes when passed `pandas.Series` of length one. +* :py:func:`pvlib.singlediode.bishop88` with ``method='newton'`` no longer + crashes when passed ``pandas.Series`` of length one. (:issue:`1787`, :pull:`1822`) -* :py:class:`pvlib.pvsystem.PVSystem` now correctly passes ``n_ar`` module - parameter to :py:func:`pvlib.iam.physical` when this IAM model is specified - or inferred. (:pull:`1832`) +* :py:class:`~pvlib.pvsystem.PVSystem` now correctly passes ``n_ar`` module + parameter to :py:func:`pvlib.iam.physical` when this IAM model is specified + or inferred. (:pull:`1832`) + Testing ~~~~~~~ * Added GitHub action to lint file changes with Flake8, replacing Stickler-CI. - (:issue:`776`, :issue:`1722`, :pull:`1786`) + (:issue:`776`, :issue:`1722`, :pull:`1723`, :pull:`1786`) + Documentation ~~~~~~~~~~~~~ * Added docstring detail for :py:func:`pvlib.iam.schlick_diffuse`. (:issue:`1811`, :pull:`1812`) -* Removed Stickler-CI integration as the service has ceased June 2023. - (:issue:`1722`, :pull:`1723`) * Specified that :py:func:`pvlib.singlediode.bishop88`, :py:func:`pvlib.singlediode.bishop88_i_from_v`, and - :py:func:`pvlib.singlediode.bishop88_v_from_i` parameters `breakdown_factor`, - `breakdown_voltage`, and `breakdown_exp` should be floats. + :py:func:`pvlib.singlediode.bishop88_v_from_i` parameters ``breakdown_factor``, + ``breakdown_voltage``, and ``breakdown_exp`` should be floats. (:issue:`1820`, :pull:`1821`) * Fix and update example in :py:func:`pvlib.pvsystem.retrieve_sam`. (:issue:`1741`, :pull:`1833`) -* Fix error in :py:func:`pvlib.iotools.get_pvgis_hourly` documentation of `surface_azimuth`. +* Fix error in :py:func:`pvlib.iotools.get_pvgis_hourly` documentation of ``surface_azimuth``. (:issue:`1724`, :pull:`1838`) -* Update definition of snow events parameter for :py:func:`pvlib.snow.loss_townsend`. +* Update definition of ``snow_events`` parameter for :py:func:`pvlib.snow.loss_townsend`. (:issue:`1839`, :pull:`1840`) * Added gallery example demonstrating how horizon profile data from :py:func:`pvlib.iotools.get_pvgis_horizon`, can be used to apply horizon shading to time series dni and global poa data. (:pull:`1849`) - -Requirements -~~~~~~~~~~~~ Contributors @@ -85,3 +79,8 @@ Contributors * Saurabh Aneja (:ghuser:`spaneja`) * Miroslav Šedivý (:ghuser:`eumiro`) * kjsauer (:ghuser:`kjsauer`) +* Jules Chéron (:ghuser:`jules-ch`) +* Cliff Hansen (:ghuser:`cwhanse`) +* Will Holmgren (:ghuser:`wholmgren`) +* Mark Mikofski (:ghuser:`mikofski`) +* Kevin Anderson (:ghuser:`kandersolar`) diff --git a/docs/sphinx/source/whatsnew/v0.10.3.rst b/docs/sphinx/source/whatsnew/v0.10.3.rst new file mode 100644 index 0000000000..efa2fab075 --- /dev/null +++ b/docs/sphinx/source/whatsnew/v0.10.3.rst @@ -0,0 +1,26 @@ +.. _whatsnew_01030: + + +v0.10.3 (Anticipated December, 2023) +------------------------------------ + + +Enhancements +~~~~~~~~~~~~ + + +Bug fixes +~~~~~~~~~ + + +Testing +~~~~~~~ + + +Documentation +~~~~~~~~~~~~~ + + +Contributors +~~~~~~~~~~~~ +