Skip to content

Add NSRDB GOES v4 to iotools #2378

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.

Sign up for GitHub

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 55 commits into from
Apr 23, 2025
Merged

Add NSRDB GOES v4 to iotools #2378

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
55 commits
Select commit Hold shift + click to select a range
485165b
added goes4
williamhobbs Feb 6, 2025
856abc7
added goes4 to iotools __init__.py
williamhobbs Feb 6, 2025
026738e
change zenith to solar_zenith
williamhobbs Feb 6, 2025
ee9d526
fixed references to psm3
williamhobbs Feb 6, 2025
4af81a7
fixed some linter issues
williamhobbs Feb 6, 2025
547bf02
uppdated whatsnew
williamhobbs Feb 6, 2025
fee3743
fixed more formating issues
williamhobbs Feb 6, 2025
2664d03
added tests and test data
williamhobbs Feb 7, 2025
0118317
fixed linter issues
williamhobbs Feb 7, 2025
2f6817c
Update docs/sphinx/source/whatsnew/v0.11.3.rst
williamhobbs Feb 7, 2025
fe8821d
change "goes4" to "psm4"
williamhobbs Feb 8, 2025
b3eb5a5
Merge branch 'nsrdb_goes_v4' of https://github.com/williamhobbs/pvlib…
williamhobbs Feb 8, 2025
f5dec0a
fix some missed goes4 instances
williamhobbs Feb 8, 2025
c23ce24
init file goes4 --> psm4
wholmgren Feb 12, 2025
c857047
use urljoin
wholmgren Feb 12, 2025
c216255
use str year in test
wholmgren Feb 12, 2025
3144899
remove versionchanged doc warning
wholmgren Feb 12, 2025
bd4f760
Merge pull request #1 from wholmgren/nsrdb_goes_v4
williamhobbs Feb 13, 2025
30bf1b1
fix function names in whatsnew
williamhobbs Feb 13, 2025
703685a
Merge branch 'nsrdb_goes_v4' of https://github.com/williamhobbs/pvlib…
williamhobbs Feb 13, 2025
d75c5a0
another whatsnew fix
williamhobbs Feb 13, 2025
9c1230c
Merge branch 'main' into nsrdb_goes_v4
williamhobbs Feb 13, 2025
4524551
created separate get_nsrdb_psm4_ functions
williamhobbs Feb 13, 2025
87d701c
update whatsnew
williamhobbs Feb 13, 2025
5a13994
update docs for API changes
williamhobbs Feb 13, 2025
523877b
update docs for API changes
williamhobbs Feb 13, 2025
af8ebd4
addressed many of adamrjensen's initial comments
williamhobbs Apr 2, 2025
999bfa6
Merge branch 'nsrdb_goes_v4' into nsrdb_psm4_dedicated_get_functions
williamhobbs Apr 3, 2025
44a9ef1
Merge pull request #2 from williamhobbs/nsrdb_psm4_dedicated_get_func…
williamhobbs Apr 3, 2025
502b323
addressed more of adam's comments
williamhobbs Apr 3, 2025
cabe2fc
move nrel api key fixture to conftest
kandersolar Apr 4, 2025
ae7b6e7
Merge remote-tracking branch 'upstream/main' into pr/2378
kandersolar Apr 4, 2025
60ade0e
move whatsnew entry to 0.12.1
kandersolar Apr 4, 2025
3196b60
move data files to new test data location
kandersolar Apr 4, 2025
8f5ae98
lint
kandersolar Apr 4, 2025
3fbd34a
Merge branch 'main' into nsrdb_goes_v4
williamhobbs Apr 4, 2025
709e4a2
Update tests/conftest.py
williamhobbs Apr 9, 2025
8a5b814
Merge branch 'main' into nsrdb_goes_v4
williamhobbs Apr 9, 2025
eab4f79
Update pvlib/iotools/psm4.py
williamhobbs Apr 10, 2025
457a927
fixed default name for psm4 tmy
williamhobbs Apr 18, 2025
2301778
moved utc earlier
williamhobbs Apr 18, 2025
1bbe7b0
replace time_period with time_step
williamhobbs Apr 21, 2025
654d3cf
replace 'names' with 'year'
williamhobbs Apr 21, 2025
2174d28
Merge branch 'main' into nsrdb_goes_v4
williamhobbs Apr 21, 2025
e0406b3
fixed linting issue
williamhobbs Apr 21, 2025
e307baf
Merge branch 'nsrdb_goes_v4' of https://github.com/williamhobbs/pvlib…
williamhobbs Apr 21, 2025
afd0519
update tests
williamhobbs Apr 21, 2025
96de0e2
Merge branch 'main' into nsrdb_goes_v4
williamhobbs Apr 21, 2025
bd3a9e4
replace interval with time_step in test_psm4
williamhobbs Apr 21, 2025
3c930fa
Merge branch 'nsrdb_goes_v4' of https://github.com/williamhobbs/pvlib…
williamhobbs Apr 21, 2025
996b4b8
replace attributes with parameters in test_psm4
williamhobbs Apr 21, 2025
1ff7ed7
remove alpha and asymmetry
williamhobbs Apr 21, 2025
d7e8325
add test for psm4 full disc
williamhobbs Apr 21, 2025
73a1854
add alpha and asymmetry back
williamhobbs Apr 21, 2025
6d89fab
add alpha and asymmetry back to other test files
williamhobbs Apr 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions docs/sphinx/source/reference/iotools.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why don't we make this a private function for now so we don't have to deprecate it later?

Copy link
Member

@wholmgren wholmgren Apr 10, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are we also going to add support for buffers to read_nsrdb_psm4? I recommend moving forward with this PR API as is and if you want to take that on before the next release then go for it.

Also need to edit the docstring returns sections if this function becomes private.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I vote for the other Will H.'s recommendation.

iotools.get_psm3
iotools.read_psm3
iotools.parse_psm3
Expand Down
8 changes: 8 additions & 0 deletions docs/sphinx/source/whatsnew/v0.12.1.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
~~~~~~~~~~~~~
Expand All @@ -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`)
6 changes: 6 additions & 0 deletions pvlib/iotools/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading
Loading