Add NSRDB GOES v4 to iotools (#2378)

* added goes4

* added goes4 to iotools __init__.py

* change zenith to solar_zenith

* fixed references to psm3

* fixed some linter issues

* uppdated whatsnew

* fixed more formating issues

* added tests and test data

* fixed linter issues

* Update docs/sphinx/source/whatsnew/v0.11.3.rst

Co-authored-by: Echedey Luis <[email protected]>

* change "goes4" to "psm4"

* fix some missed goes4 instances

* init file goes4 --> psm4

* use urljoin

* use str year in test

* remove versionchanged doc warning

* fix function names in whatsnew

* another whatsnew fix

* created separate get_nsrdb_psm4_ functions

* update whatsnew

* update docs for API changes

* update docs for API changes

* addressed many of adamrjensen's initial comments

* addressed more of adam's comments

* move nrel api key fixture to conftest

* move whatsnew entry to 0.12.1

* move data files to new test data location

* lint

* Update tests/conftest.py

Co-authored-by: Will Holmgren <[email protected]>

* Update pvlib/iotools/psm4.py

Co-authored-by: Adam R. Jensen <[email protected]>

* fixed default name for psm4 tmy

* moved utc earlier

* replace time_period with time_step

* replace 'names' with 'year'

* fixed linting issue

* update tests

* replace interval with time_step in test_psm4

* replace attributes with parameters in test_psm4

* remove alpha and asymmetry

* add test for psm4 full disc

* add alpha and asymmetry back

* add alpha and asymmetry back to other test files

---------

Co-authored-by: Echedey Luis <[email protected]>
Co-authored-by: Will Holmgren <[email protected]>
Co-authored-by: Kevin Anderson <[email protected]>
Co-authored-by: Adam R. Jensen <[email protected]>

Author: 5 people

docs/sphinx/source/reference/iotools.rst

@@ -26,6 +26,12 @@ of sources and file formats relevant to solar energy modeling.
    iotools.read_crn
    iotools.read_solrad
    iotools.get_solrad
+   iotools.get_nsrdb_psm4_aggregated
+   iotools.get_nsrdb_psm4_tmy
+   iotools.get_nsrdb_psm4_conus
+   iotools.get_nsrdb_psm4_full_disc
+   iotools.read_nsrdb_psm4
+   iotools.parse_nsrdb_psm4
    iotools.get_psm3
    iotools.read_psm3
    iotools.parse_psm3

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

@@ -19,6 +19,13 @@ Enhancements
   data (:py:func:`~pvlib.ivtools.sdm.fit_pvsyst_iec61853_sandia_2025`). (:issue:`2185`, :pull:`2429`)
 * Add optional arguments ``temperature_ref`` and ``irradiance_ref`` to
   :py:func:`~pvlib.pvsystem.sapm`(:issue:`2432`, :pull:`2434`)
+* Add NREL NSRDB PSM v4 API client to :py:mod:`pvlib.iotools`. See
+  :py:func:`~pvlib.iotools.get_nsrdb_psm4_aggregated`,
+  :py:func:`~pvlib.iotools.get_nsrdb_psm4_tmy`,
+  :py:func:`~pvlib.iotools.get_nsrdb_psm4_conus`,
+  :py:func:`~pvlib.iotools.get_nsrdb_psm4_full_disc`,
+  :py:func:`~pvlib.iotools.read_nsrdb_psm4`, and
+  :py:func:`~pvlib.iotools.parse_nsrdb_psm4`. (:issue:`2326`, :pull:`2378`)
 
 Documentation
 ~~~~~~~~~~~~~
@@ -44,5 +51,6 @@ Contributors
 ~~~~~~~~~~~~
 * Cliff Hansen (:ghuser:`cwhanse`)
 * Rajiv Daxini (:ghuser:`RDaxini`)
+* Will Hobbs (:ghuser:`williamhobbs`)
 * Kevin Anderson (:ghuser:`kandersolar`)
 * Will Holmgren (:ghuser:`wholmgren`)

pvlib/iotools/__init__.py

@@ -11,6 +11,12 @@
 from pvlib.iotools.psm3 import get_psm3  # noqa: F401
 from pvlib.iotools.psm3 import read_psm3  # noqa: F401
 from pvlib.iotools.psm3 import parse_psm3  # noqa: F401
+from pvlib.iotools.psm4 import get_nsrdb_psm4_aggregated  # noqa: F401
+from pvlib.iotools.psm4 import get_nsrdb_psm4_tmy  # noqa: F401
+from pvlib.iotools.psm4 import get_nsrdb_psm4_conus  # noqa: F401
+from pvlib.iotools.psm4 import get_nsrdb_psm4_full_disc  # noqa: F401
+from pvlib.iotools.psm4 import read_nsrdb_psm4  # noqa: F401
+from pvlib.iotools.psm4 import parse_nsrdb_psm4  # noqa: F401
 from pvlib.iotools.pvgis import get_pvgis_tmy, read_pvgis_tmy  # noqa: F401
 from pvlib.iotools.pvgis import read_pvgis_hourly  # noqa: F401
 from pvlib.iotools.pvgis import get_pvgis_hourly  # noqa: F401