Skip to content
Merged
Show file tree
Hide file tree
Changes from 15 commits
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
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
6 changes: 6 additions & 0 deletions docs/sphinx/source/whatsnew/v0.11.2.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,12 @@ Enhancements
Documentation
~~~~~~~~~~~~~
* Edited docstrings for :py:func:`~pvlib.pvsystem.dc_ohms_from_percent` and
:py:func:`~pvlib.pvsystem.dc_ohmic_loss` for clarity. (:issue:`1601`, :pull:`2229`)
* Corrected the default values for module height and racking model to None in
the :py:class:`~pvlib.pvsystem.PVSystem` and
:py:class:`~pvlib.pvsystem.FixedMount` docstrings, added the freestanding
racking model option, and various formatting edits for clarity.
(:issue:`1942`, :pull:`2232`)
:py:func:`~pvlib.pvsystem.dc_ohmic_losses` for clarity. (:issue:`1601`, :pull:`2229`)
* Updated :py:func:`~pvlib.irradiance.reindl` to include definitions of terms
and a new "notes" section (:issue:`2183`, :pull:`2193`)
Expand Down
47 changes: 23 additions & 24 deletions pvlib/pvsystem.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
from abc import ABC, abstractmethod
from typing import Optional, Union

from pvlib._deprecation import deprecated, warn_deprecated
from pvlib._deprecation import deprecated

import pvlib # used to avoid albedo name collision in the Array class
from pvlib import (atmosphere, iam, inverter, irradiance,
Expand Down Expand Up @@ -104,30 +104,30 @@ class PVSystem:
----------
arrays : Array or iterable of Array, optional
An Array or list of arrays that are part of the system. If not
specified a single array is created from the other parameters (e.g.
specified, a single array is created from the other parameters (e.g.
`surface_tilt`, `surface_azimuth`). If specified as a list, the list
must contain at least one Array;
if length of arrays is 0 a ValueError is raised. If `arrays` is
specified the following PVSystem parameters are ignored:

- `surface_tilt`
- `surface_azimuth`
- `albedo`
- `surface_type`
- `module`
- `module_type`
- `module_parameters`
- `temperature_model_parameters`
- `modules_per_string`
- `strings_per_inverter`
- ``surface_tilt``
- ``surface_azimuth``
- ``albedo``
- ``surface_type``
- ``module``
- ``module_type``
- ``module_parameters``
- ``temperature_model_parameters``
- ``modules_per_string``
- ``strings_per_inverter``

surface_tilt: float or array-like, default 0
Surface tilt angles in decimal degrees.
The tilt angle is defined as degrees from horizontal
(e.g. surface facing up = 0, surface facing horizon = 90)

surface_azimuth: float or array-like, default 180
Azimuth angle of the module surface.
Azimuth angle of the module surface in decimal degrees.
North=0, East=90, South=180, West=270.

albedo : float, optional
Expand All @@ -142,8 +142,6 @@ class PVSystem:

module : string, optional
The model name of the modules.
May be used to look up the module_parameters dictionary
via some other method.

module_type : string, default 'glass_polymer'
Describes the module's construction. Valid strings are 'glass_polymer'
Expand All @@ -154,7 +152,8 @@ class PVSystem:

temperature_model_parameters : dict or Series, optional
Temperature model parameters as required by one of the models in
pvlib.temperature (excluding poa_global, temp_air and wind_speed).
:py:mod:`pvlib.temperature` (excluding ``poa_global``, ``temp_air`` and
``wind_speed``).

modules_per_string: int or float, default 1
See system topology discussion above.
Expand All @@ -164,15 +163,14 @@ class PVSystem:

inverter : string, optional
The model name of the inverters.
May be used to look up the inverter_parameters dictionary
via some other method.

inverter_parameters : dict or Series, optional
Inverter parameters as defined by the SAPM, CEC, or other.

racking_model : string, default 'open_rack'
Valid strings are 'open_rack', 'close_mount', and 'insulated_back'.
Used to identify a parameter set for the SAPM cell temperature model.
racking_model : string, optional
Valid strings are 'open_rack', 'close_mount', 'freestanding', or
'insulated_back'.
Used to identify a parameter set for the cell temperature model.

losses_parameters : dict or Series, optional
Losses parameters as defined by PVWatts or other.
Expand All @@ -186,7 +184,7 @@ class PVSystem:
Raises
------
ValueError
If `arrays` is not None and has length 0.
If ``arrays`` is not None and has length 0.

See also
--------
Expand Down Expand Up @@ -1374,8 +1372,9 @@ class FixedMount(AbstractMount):
West=270. [degrees]

racking_model : str, optional
Valid strings are 'open_rack', 'close_mount', and 'insulated_back'.
Used to identify a parameter set for the SAPM cell temperature model.
Valid strings are 'open_rack', 'close_mount', 'freestanding', or
'insulated_back'.
Used to identify a parameter set for the cell temperature model.

module_height : float, optional
The height above ground of the center of the module [m]. Used for
Expand Down
Loading