8000 Revise modelchain.rst for multiple arrays, results attribute by cwhanse · Pull Request #1223 · pvlib/pvlib-python · GitHub
[go: up one dir, main page]
Skip to content

Revise modelchain.rst for multiple arrays, results attribute #1223

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 27 commits into from
May 14, 2021
Merged

Revise modelchain.rst for multiple arrays, results attribute #1223

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
18797ea
revise for new run_model methods, .results attribute, multiple arrays
cwhanse May 9, 2021
cf20167
fix typos, use bullets instead of table
cwhanse May 9, 2021
586c777
improvements, add with_ class methods
cwhanse May 9, 2021
011bfa8
fix mistake
cwhanse May 9, 2021
11f5578
fix another mistake
cwhanse May 9, 2021
12547a4
fix cross reference
cwhanse May 10, 2021
a3efba1
updates from review
cwhanse May 10, 2021
4e7cf88
more use of formatting
cwhanse May 10, 2021
fe54d66
fix link
cwhanse May 10, 2021
999c3d0
refix link
cwhanse May 10, 2021
67580d0
clear up deprecations
cwhanse May 11, 2021
f86d7e3
a few more, print inverter model inference helpers
cwhanse May 11, 2021
1153904
correct references
cwhanse May 11, 2021
9f8911e
revisions from review
cwhanse May 12, 2021
10f117c
fix up loop in pvusa_mc_wrapper
cwhanse May 12, 2021
23abfa6
indents
cwhanse May 12, 2021
a04e3f9
correct references
cwhanse May 12, 2021
394f72d
thrash some more
cwhanse May 12, 2021
0e45c01
suppress long output
cwhanse May 12, 2021
4e620ba
add comments to user function example
cwhanse May 12, 2021
46c614d
add :
cwhanse May 12, 2021
2fc3899
spacing
cwhanse May 12, 2021
48ca84b
move comments to docstring so they appear in rtd
cwhanse May 12, 2021
6813c8e
improvements from review
cwhanse May 13, 2021
6548592
last edits
cwhanse May 13, 2021
404e1cc
spelling
cwhanse May 13, 2021
53e392a
remove unneeded unwrap in example function
cwhanse May 13, 2021
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
Prev Previous commit
Next Next commit
updates from review
  • Loading branch information
@cwhanse
cwhanse committed May 10, 2021
commit a3efba1370ad1f2792d1b719fe8b89cc27540bc1
2 changes: 2 additions & 0 deletions docs/sphinx/source/api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -572,6 +572,8 @@ Creating a ModelChain object.
modelchain.ModelChain.with_pvwatts
modelchain.ModelChain.with_sapm

.. _modelchain_runmodel:

Running
-------

Expand Down
17 changes: 9 additions & 8 deletions docs/sphinx/source/modelchain.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,17 +12,18 @@ without a solid understanding of classes.

A :py:class:`~.modelchain.ModelChain` has three components:

* a :py:class:`~.pvsystem.PVSystem` object, representin a collection of modules and inverters
* a :py:class:`~.pvsystem.PVSystem` object, representing a collection of modules and inverters
* a :py:class:`~.location.Location` object, representing a location on the planet
* values for attributes that specify the model to be used for for each step in the PV modeling
process.

Modeling with a :py:class:`~.ModelChain` typically involves 3 steps:

1. Creating an instance of :py:class:`~pvlib.modelchain.ModelChain`.
2. Executing a ModelChain.run_model method with weather data as input.
3. Examining the model results that are stored in the ModelChain's ``results``
attribute.
2. Executing a ModelChain.run_model method with weather data as input. See
:ref:`_modelchain_runmodel` for a list of run_model methods.
3. Examining the model results that are stored in the ModelChain's
:py:class:`ModelChain.results <.ModelChain.ModelChainResult>` attribute.

A simple ModelChain example
---------------------------
Expand Down Expand Up @@ -159,7 +160,7 @@ model, AC model, AOI loss model, and spectral loss model.
mc.ac

Alternatively, we could have specified single diode or PVWatts related
information in the PVSystem construction. Here we assign parameters for
information in the PVSystem construction. Here we pass parameters for
PVWatts models to the PVSystem. ModelChain will automatically determine that
it should choose PVWatts DC and AC models. ModelChain still needs us to specify
``aoi_model`` and ``spectral_model`` keyword arguments because the
Expand Down Expand Up @@ -263,8 +264,8 @@ assigned to generic names, as described in the next section.

The methods called by :py:meth:`~pvlib.modelchain.ModelChain.run_model`
store their results in the ``results`` attribute, which is an instance of
:py:class:`~ModelChainResult`. :py:class:`~ModelChainResult` has the following
attributes:
:py:class:`~.ModelChainResult`. :py:class:`~.ModelChainResult` has the
following attributes:
``weather``, ``times``, ``solar_position``, ``airmass``, ``total_irrad``,
``aoi``, ``aoi_modifier``, ``spectral_modifier``,``effective_irradiance``,
``cell_temperature``, ``dc``, ``ac``, ``losses``, ``tracking``,
Expand Down Expand Up @@ -413,7 +414,7 @@ shown below.


ModelChain for a PVSystem with multiple Arrays
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

The PVSystem can represent a PV system with a single array of modules, or
with multiple arrays (see :ref:`_multiarray`). The same models are applied to
Expand Down
0