Skip to content

Commit f75a3a4

Browse files
veronicaguowholmgren
authored andcommitted
Fix documentation references to inverter/module data (#791)
* Fix inverter names in documentation - to match new cec updates * Add an example module in cec data file. * Fix `run_model()` inputs in doc * Fix old NREL data link * Update whatsnew * Fix lint error * Use Canadian Solar CS5P-220M in examples
1 parent a72aca7 commit f75a3a4

File tree

6 files changed

+12
-7
lines changed

6 files changed

+12
-7
lines changed

docs/sphinx/source/forecasts.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -447,7 +447,7 @@ for details.
447447
sandia_modules = retrieve_sam('sandiamod')
448448
cec_inverters = retrieve_sam('cecinverter')
449449
module = sandia_modules['Canadian_Solar_CS5P_220M___2009_']
450-
inverter = cec_inverters['SMA_America__SC630CP_US_315V__CEC_2012_']
450+
inverter = cec_inverters['SMA_America__SC630CP_US__with_ABB_EcoDry_Ultra_transformer_']
451451
temperature_model_parameters = TEMPERATURE_MODEL_PARAMETERS['sapm']['open_rack_glass_glass']
452452
453453
# model a big tracker for more fun
@@ -461,7 +461,7 @@ for details.
461461
mc = ModelChain(system, fx_model.location)
462462
463463
# extract relevant data for model chain
464-
mc.run_model(fx_data.index, weather=fx_data);
464+
mc.run_model(fx_data);
465465
466466
Now we plot a couple of modeling intermediates and the forecast power.
467467
Here's the forecast plane of array irradiance...

docs/sphinx/source/introexamples.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ configuration at a handful of sites listed below.
4545
sandia_modules = pvlib.pvsystem.retrieve_sam('SandiaMod')
4646
sapm_inverters = pvlib.pvsystem.retrieve_sam('cecinverter')
4747
module = sandia_modules['Canadian_Solar_CS5P_220M___2009_']
48-
inverter = sapm_inverters['ABB__MICRO_0_25_I_OUTD_US_208_208V__CEC_2014_']
48+
inverter = sapm_inverters['ABB__MICRO_0_25_I_OUTD_US_208__208V_']
4949
temperature_model_parameters = pvlib.temperature.TEMPERATURE_MODEL_PARAMETERS['sapm']['open_rack_glass_glass']
5050
5151
# specify constant ambient air temp and wind for simplicity

docs/sphinx/source/modelchain.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ objects, module data, and inverter data.
5353
cec_inverters = pvlib.pvsystem.retrieve_sam('cecinverter')
5454
5555
sandia_module = sandia_modules['Canadian_Solar_CS5P_220M___2009_']
56-
cec_inverter = cec_inverters['ABB__MICRO_0_25_I_OUTD_US_208_208V__CEC_2014_']
56+
cec_inverter = cec_inverters['ABB__MICRO_0_25_I_OUTD_US_208__208V_']
5757
5858
Now we create a Location object, a PVSystem object, and a ModelChain
5959
object.

docs/sphinx/source/pvsystem.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -130,9 +130,9 @@ the :py:func:`~pvlib.pvsystem.retrieve_sam` function:
130130
# retrieve_sam returns a dict. the dict keys are module names,
131131
# and the values are model parameters for that module
132132
modules = pvsystem.retrieve_sam('cecmod')
133-
module_parameters = modules['Example_Module']
133+
module_parameters = modules['Canadian_Solar_Inc__CS5P_220M']
134134
inverters = pvsystem.retrieve_sam('cecinverter')
135-
inverter_parameters = inverters['ABB__MICRO_0_25_I_OUTD_US_208_208V__CEC_2014_']
135+
inverter_parameters = inverters['ABB__MICRO_0_25_I_OUTD_US_208__208V_']
136136
system = pvsystem.PVSystem(module_parameters=module_parameters, inverter_parameters=inverter_parameters)
137137
138138

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -117,6 +117,7 @@ Testing
117117
Documentation
118118
~~~~~~~~~~~~~
119119
* Corrected docstring for `pvsystem.PVSystem.sapm`
120+
* Fixed broken ipython examples from CEC data updates
120121

121122
Removal of prior version deprecations
122123
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -146,3 +147,4 @@ Contributors
146147
* Anton Driesse (:ghuser:`adriesse`)
147148
* Alexander Morgan (:ghuser:`alexandermorgan`)
148149
* Miguel Sánchez de León Peque (:ghuser:`Peque`)
150+
* Veronica Guo (:ghuser:`veronicaguo`)

pvlib/pvsystem.py

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1800,7 +1800,10 @@ def retrieve_sam(name=None, path=None):
18001800
18011801
Notes
18021802
-----
1803-
Files available at https://sam.nrel.gov/sites/default/files/
1803+
Files available at
1804+
https://github.com/NREL/SAM/tree/develop/deploy/libraries
1805+
Documentation for module and inverter data sets:
1806+
https://sam.nrel.gov/photovoltaic/pv-sub-page-2.html
18041807
18051808
Examples
18061809
--------

0 commit comments

Comments
 (0)