Skip to content

[DOC] add TEMPERATURE_MODEL_PARAMETERS to api.rst #1036

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 4 commits into from
Sep 2, 2020
Merged

[DOC] add TEMPERATURE_MODEL_PARAMETERS to api.rst #1036

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5e9f1f6
add TEMPERATURE_MODEL_PARAMETERS to api.rst
mikofski Aug 27, 2020
eecdefa
apply suggested changes to temp model params docstring
mikofski Aug 27, 2020
9bf82de
Merge branch 'master' into doc-temp-model-params
mikofski Sep 2, 2020
b63c35f
fix stickler, typos in example
mikofski Sep 2, 2020
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
8 changes: 8 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 @@ -238,6 +238,14 @@ PV temperature models
temperature.pvsyst_cell
temperature.faiman

Temperature Model Parameters
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. currentmodule:: pvlib.temperature
.. autodata:: TEMPERATURE_MODEL_PARAMETERS
:annotation:

.. currentmodule:: pvlib

Single diode models
-------------------

Expand Down
25 changes: 20 additions & 5 deletions pvlib/temperature.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,21 @@
'pvsyst': {'freestanding': {'u_c': 29.0, 'u_v': 0},
'insulated': {'u_c': 15.0, 'u_v': 0}}
}
"""Dictionary of temperature parameters organized by model.

There are keys for each model at the top level. Currently there are two models,
``'sapm'`` for the Sandia Array Performance Model, and ``'pvsyst'``. Each model
has a dictionary of configurations; a value is itself a dictionary containing model
parameters. Retrieve parameters by indexing the model and
configuration by name. Note: the keys are lower-cased and case sensitive.

Example
-------
Retrieve the open rack glass-polymer configuration for SAPM::

from pvlib.temperature import TEMPERATURE_MODEL_PARAMS
temp_params = TEMPERATURE_MODEL_PARAMETERS['sapm']['open_rack_glass_polymer']
"""


def _temperature_model_params(model, parameter_set):
Expand Down Expand Up @@ -87,7 +102,7 @@ def sapm_cell(poa_global, temp_air, wind_speed, a, b, deltaT,
ambient air temperature :math:`T_{a}` (C). Model parameters depend both on
the module construction and its mounting. Parameter sets are provided in
[1]_ for representative modules and mounting, and are coded for convenience
in ``pvlib.temperature.TEMPERATURE_MODEL_PARAMETERS``.
in :data:`~pvlib.temperature.TEMPERATURE_MODEL_PARAMETERS`.

+---------------+----------------+-------+---------+---------------------+
| Module | Mounting | a | b | :math:`\Delta T [C]`|
Expand Down Expand Up @@ -168,7 +183,7 @@ def sapm_module(poa_global, temp_air, wind_speed, a, b):
:math:`T_{C}`. Model parameters depend both on the module construction and
its mounting. Parameter sets are provided in [1]_ for representative
modules and mounting, and are coded for convenience in
``temperature.TEMPERATURE_MODEL_PARAMETERS``.
:data:`~pvlib.temperature.TEMPERATURE_MODEL_PARAMETERS`.

+---------------+----------------+-------+---------+---------------------+
| Module | Mounting | a | b | :math:`\Delta T [C]`|
Expand Down Expand Up @@ -238,7 +253,7 @@ def sapm_cell_from_module(module_temperature, poa_global, deltaT,
Model parameters depend both on the module construction and its mounting.
Parameter sets are provided in [1]_ for representative modules and
mounting, and are coded for convenience in
``pvlib.temperature.TEMPERATURE_MODEL_PARAMETERS``.
:data:`~pvlib.temperature.TEMPERATURE_MODEL_PARAMETERS`.

+---------------+----------------+-------+---------+---------------------+
| Module | Mounting | a | b | :math:`\Delta T [C]`|
Expand Down Expand Up @@ -323,8 +338,8 @@ def pvsyst_cell(poa_global, temp_air, wind_speed=1.0, u_c=29.0, u_v=0.0,
the module construction and its mounting. Parameters are provided in
[1]_ for open (freestanding) and close (insulated) mounting configurations,
, and are coded for convenience in
``temperature.TEMPERATURE_MODEL_PARAMETERS``. The heat loss factors
provided represent the combined effect of convection, radiation and
:data:`~pvlib.temperature.TEMPERATURE_MODEL_PARAMETERS`. The heat loss
factors provided represent the combined effect of convection, radiation and
conduction, and their values are experimentally determined.

+--------------+---------------+---------------+
Expand Down