Skip to content

Add example of remote fetch of database with pvsystem.retrieve_sam #2313

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 9 commits into from
Dec 3, 2024
Merged

Add example of remote fetch of database with pvsystem.retrieve_sam #2313

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
381ff41
Update pvsystem.py
echedey-ls Nov 27, 2024
c6e4f41
Update v0.11.2.rst
echedey-ls Nov 27, 2024
2170d58
Update pvsystem.py
echedey-ls Nov 27, 2024
160f151
review
echedey-ls Dec 3, 2024
1701d8b
remove returns name
echedey-ls Dec 3, 2024
33d337e
do not format bulleted list into citation block
echedey-ls Dec 3, 2024
aaa9353
Format strings as code
echedey-ls Dec 3, 2024
5d9afb6
Add titles to each example
echedey-ls Dec 3, 2024
626ab43
Pass database name as keyword
echedey-ls Dec 3, 2024
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
2 changes: 2 additions & 0 deletions docs/sphinx/source/whatsnew/v0.11.2.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,8 @@ Documentation

- `spectra` and `spectra_components` (:issue:`2150`, :pull:`2264`)

* Added a example to :py:func:`~pvlib.pvsystem.retrieve_sam` docstring to
demonstrate how to retrieve a database from the SAM repo. (:pull:`2313`)

Testing
~~~~~~~
Expand Down
8 changes: 7 additions & 1 deletion pvlib/pvsystem.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2060,7 +2060,13 @@ def retrieve_sam(name=None, path=None):
CEC_Date NaN
CEC_Type Utility Interactive
Name: AE_Solar_Energy__AE6_0__277V_, dtype: object
"""

# using the latest CEC Inverter database, via URL
>>> inv_db = pvsystem.retrieve_sam(path="https://raw.githubusercontent.com/NREL/SAM/refs/heads/develop/deploy/libraries/CEC%20Inverters.csv")
>>> inv_db.keys()
Index(['ABB__PVI_3_0_OUTD_S_US_A__208V_', 'ABB__PVI_3_0_OUTD_S_US_A__240V_', ...],
dtype='object', length=...)
""" # noqa: E501
# error: path was previously silently ignored if name was given GH#2018
if name is not None and path is not None:
raise ValueError("Please provide either 'name' or 'path', not both.")
Expand Down
Loading