Skip to content

Fix documentation references to inverter/module data #791

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 7 commits into from
Oct 18, 2019
Merged

Fix documentation references to inverter/module data #791

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
0695f86
Fix inverter names in documentation
veronicaguo Oct 8, 2019
7b6516d
Add an example module in cec data file.
veronicaguo Oct 17, 2019
364bf54
Fix `run_model()` inputs in doc
veronicaguo Oct 17, 2019
b2a0c42
Fix old NREL data link
veronicaguo Oct 17, 2019
749aaea
Update whatsnew
veronicaguo Oct 17, 2019
c55fa1c
Fix lint error
veronicaguo Oct 17, 2019
7ce6d91
Use Canadian Solar CS5P-220M in examples
veronicaguo Oct 17, 2019
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
4 changes: 2 additions & 2 deletions docs/sphinx/source/forecasts.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -447,7 +447,7 @@ for details.
sandia_modules = retrieve_sam('sandiamod')
cec_inverters = retrieve_sam('cecinverter')
module = sandia_modules['Canadian_Solar_CS5P_220M___2009_']
inverter = cec_inverters['SMA_America__SC630CP_US_315V__CEC_2012_']
inverter = cec_inverters['SMA_America__SC630CP_US__with_ABB_EcoDry_Ultra_transformer_']
Copy link
Member

Choose a reason for hiding this comment

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

Can you check how the pages render on readthedocs? You should be able to login to readthedocs and set it up so that this branch is built. If you've done that, thanks already.

Copy link
Member

Choose a reason for hiding this comment

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

It's no longer necessary for contributors to create their own readthedocs account. Click on the continuous-documentation/read-the-docs check in the merge status box below.

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've built this branch with readthedocs already and rendering looks good. Didn't realise there is continuous-documentation/read-the-docs below... that's so much easier. Thanks for pointing it out!

temperature_model_parameters = TEMPERATURE_MODEL_PARAMETERS['sapm']['open_rack_glass_glass']

# model a big tracker for more fun
Expand All @@ -461,7 +461,7 @@ for details.
mc = ModelChain(system, fx_model.location)

# extract relevant data for model chain
mc.run_model(fx_data.index, weather=fx_data);
mc.run_model(fx_data);

Now we plot a couple of modeling intermediates and the forecast power.
Here's the forecast plane of array irradiance...
Expand Down
2 changes: 1 addition & 1 deletion docs/sphinx/source/introexamples.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ configuration at a handful of sites listed below.
sandia_modules = pvlib.pvsystem.retrieve_sam('SandiaMod')
sapm_inverters = pvlib.pvsystem.retrieve_sam('cecinverter')
module = sandia_modules['Canadian_Solar_CS5P_220M___2009_']
inverter = sapm_inverters['ABB__MICRO_0_25_I_OUTD_US_208_208V__CEC_2014_']
inverter = sapm_inverters['ABB__MICRO_0_25_I_OUTD_US_208__208V_']
temperature_model_parameters = pvlib.temperature.TEMPERATURE_MODEL_PARAMETERS['sapm']['open_rack_glass_glass']

# specify constant ambient air temp and wind for simplicity
Expand Down
2 changes: 1 addition & 1 deletion docs/sphinx/source/modelchain.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ objects, module data, and inverter data.
cec_inverters = pvlib.pvsystem.retrieve_sam('cecinverter')

sandia_module = sandia_modules['Canadian_Solar_CS5P_220M___2009_']
cec_inverter = cec_inverters['ABB__MICRO_0_25_I_OUTD_US_208_208V__CEC_2014_']
cec_inverter = cec_inverters['ABB__MICRO_0_25_I_OUTD_US_208__208V_']

Now we create a Location object, a PVSystem object, and a ModelChain
object.
Expand Down
4 changes: 2 additions & 2 deletions docs/sphinx/source/pvsystem.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,9 +130,9 @@ the :py:func:`~pvlib.pvsystem.retrieve_sam` function:
# retrieve_sam returns a dict. the dict keys are module names,
# and the values are model parameters for that module
modules = pvsystem.retrieve_sam('cecmod')
module_parameters = modules['Example_Module']
module_parameters = modules['Canadian_Solar_Inc__CS5P_220M']
inverters = pvsystem.retrieve_sam('cecinverter')
inverter_parameters = inverters['ABB__MICRO_0_25_I_OUTD_US_208_208V__CEC_2014_']
inverter_parameters = inverters['ABB__MICRO_0_25_I_OUTD_US_208__208V_']
system = pvsystem.PVSystem(module_parameters=module_parameters, inverter_parameters=inverter_parameters)


Expand Down
2 changes: 2 additions & 0 deletions docs/sphinx/source/whatsnew/v0.7.0.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,7 @@ Testing
Documentation
~~~~~~~~~~~~~
* Corrected docstring for `pvsystem.PVSystem.sapm`
* Fixed broken ipython examples from CEC data updates

Removal of prior version deprecations
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down Expand Up @@ -146,3 +147,4 @@ Contributors
* Anton Driesse (:ghuser:`adriesse`)
* Alexander Morgan (:ghuser:`alexandermorgan`)
* Miguel Sánchez de León Peque (:ghuser:`Peque`)
* Veronica Guo (:ghuser:`veronicaguo`)
5 changes: 4 additions & 1 deletion pvlib/pvsystem.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1800,7 +1800,10 @@ def retrieve_sam(name=None, path=None):

Notes
-----
Files available at https://sam.nrel.gov/sites/default/files/
Files available at
https://github.com/NREL/SAM/tree/develop/deploy/libraries
Documentation for module and inverter data sets:
https://sam.nrel.gov/photovoltaic/pv-sub-page-2.html

Examples
--------
Expand Down