add functionality to load Solcast API data to iotools (#1875)

* prototype (#1)

* first iteration

* dynamic period

* docstring

* feedback

* linting

* Update pvlib/iotools/solcast.py

Co-authored-by: Cliff Hansen <cwhanse@sandia.gov>

* Update pvlib/iotools/solcast.py

Co-authored-by: Cliff Hansen <cwhanse@sandia.gov>

* Update pvlib/iotools/solcast.py

Co-authored-by: Cliff Hansen <cwhanse@sandia.gov>

* midpoint docstring

* flak8 formatting

* PR 1875 (#2)

* kandersolar feedback (#3)

* addressing feedback from Kandersolar

* Review (#4)

added hack for ISO periods in Pandas 0.25 and clearsky parameter maps

* comment on pandas version

* Update pvlib/iotools/solcast.py

Co-authored-by: Adam R. Jensen <39184289+AdamRJensen@users.noreply.github.com>

* Update pvlib/iotools/solcast.py

Co-authored-by: Adam R. Jensen <39184289+AdamRJensen@users.noreply.github.com>

* Update pvlib/iotools/solcast.py

Co-authored-by: Adam R. Jensen <39184289+AdamRJensen@users.noreply.github.com>

* Update pvlib/iotools/solcast.py

Co-authored-by: Adam R. Jensen <39184289+AdamRJensen@users.noreply.github.com>

* Update pvlib/iotools/solcast.py

Co-authored-by: Adam R. Jensen <39184289+AdamRJensen@users.noreply.github.com>

* Update pvlib/iotools/solcast.py

Co-authored-by: Adam R. Jensen <39184289+AdamRJensen@users.noreply.github.com>

* Update pvlib/iotools/solcast.py

Co-authored-by: Adam R. Jensen <39184289+AdamRJensen@users.noreply.github.com>

* Update pvlib/iotools/solcast.py

Co-authored-by: Adam R. Jensen <39184289+AdamRJensen@users.noreply.github.com>

* Update pvlib/iotools/solcast.py

Co-authored-by: Adam R. Jensen <39184289+AdamRJensen@users.noreply.github.com>

* Adams's feedback

* Update pvlib/iotools/solcast.py

Co-authored-by: Adam R. Jensen <39184289+AdamRJensen@users.noreply.github.com>

* Adams's feedback

* Last minor changes

* added test for _get_solcast

* feat: add additional test coverage (#5)

Co-authored-by: Hugh Cutcher <hugh@solcast.com.au>

* linting

---------

Co-authored-by: Cliff Hansen <cwhanse@sandia.gov>
Co-authored-by: Adam R. Jensen <39184289+AdamRJensen@users.noreply.github.com>
Co-authored-by: hugh-solcast <143680553+hugh-solcast@users.noreply.github.com>
Co-authored-by: Hugh Cutcher <hugh@solcast.com.au>

Author: 5 people

docs/sphinx/source/reference/iotools.rst

@@ -46,6 +46,10 @@ of sources and file formats relevant to solar energy modeling.
    iotools.get_acis_station_data
    iotools.get_acis_available_stations
    iotools.read_panond
+   iotools.get_solcast_tmy
+   iotools.get_solcast_historic
+   iotools.get_solcast_forecast
+   iotools.get_solcast_live
 
 
 A :py:class:`~pvlib.location.Location` object may be created from metadata

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

@@ -15,6 +15,9 @@ Enhancements
 * :py:func:`pvlib.bifacial.infinite_sheds.get_irradiance` and
   :py:func:`pvlib.bifacial.infinite_sheds.get_irradiance_poa` now include
   shaded fraction in returned variables. (:pull:`1871`)
+* Added :py:func:`~pvlib.iotools.get_solcast_tmy`, :py:func:`~pvlib.iotools.get_solcast_historic`,
+  :py:func:`~pvlib.iotools.get_solcast_forecast` and :py:func:`~pvlib.iotools.get_solcast_live` to
+  read data from the Solcast API. (:issue:`1313`, :pull:`1875`)
 * Added :py:func:`~pvlib.iam.convert` and :py:func:`~pvlib.iam.fit` that
   convert between IAM models, and that fit an IAM model to data. (:issue:`1824`, :pull:`1827`)
 
@@ -59,4 +62,5 @@ Contributors
 * :ghuser:`matsuobasho`
 * Harry Jack (:ghuser:`harry-solcast`)
 * Kevin Anderson (:ghuser:`kandersolar`)
+* Lorenzo Riches (:ghuser:`lorenzo-solcast`)
 * Cliff Hansen (:ghuser:`cwhanse`)

pvlib/iotools/__init__.py

@@ -27,3 +27,7 @@
 from pvlib.iotools.acis import get_acis_mpe  # noqa: F401
 from pvlib.iotools.acis import get_acis_station_data  # noqa: F401
 from pvlib.iotools.acis import get_acis_available_stations  # noqa: F401
+from pvlib.iotools.solcast import get_solcast_forecast  # noqa: F401
+from pvlib.iotools.solcast import get_solcast_live  # noqa: F401
+from pvlib.iotools.solcast import get_solcast_historic  # noqa: F401
+from pvlib.iotools.solcast import get_solcast_tmy  # noqa: F401