Skip to content

Commit 1ccc339

Browse files
committed
change racking_model default to none, formatting
1 parent 4cfda4a commit 1ccc339

File tree

1 file changed

+14
-12
lines changed

1 file changed

+14
-12
lines changed

pvlib/pvsystem.py

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
from abc import ABC, abstractmethod
1818
from typing import Optional, Union
1919

20-
from pvlib._deprecation import deprecated, warn_deprecated
20+
from pvlib._deprecation import deprecated
2121

2222
import pvlib # used to avoid albedo name collision in the Array class
2323
from pvlib import (atmosphere, iam, inverter, irradiance,
@@ -104,7 +104,7 @@ class PVSystem:
104104
----------
105105
arrays : Array or iterable of Array, optional
106106
An Array or list of arrays that are part of the system. If not
107-
specified a single array is created from the other parameters (e.g.
107+
specified, a single array is created from the other parameters (e.g.
108108
`surface_tilt`, `surface_azimuth`). If specified as a list, the list
109109
must contain at least one Array;
110110
if length of arrays is 0 a ValueError is raised. If `arrays` is
@@ -127,7 +127,7 @@ class PVSystem:
127127
(e.g. surface facing up = 0, surface facing horizon = 90)
128128
129129
surface_azimuth: float or array-like, default 180
130-
Azimuth angle of the module surface.
130+
Azimuth angle of the module surface in decimal degrees.
131131
North=0, East=90, South=180, West=270.
132132
133133
albedo : float, optional
@@ -142,19 +142,20 @@ class PVSystem:
142142
143143
module : string, optional
144144
The model name of the modules.
145-
May be used to look up the module_parameters dictionary
145+
May be used to look up the ``module_parameters`` dictionary
146146
via some other method.
147147
148-
module_type : string, default 'glass_polymer'
149-
Describes the module's construction. Valid strings are 'glass_polymer'
150-
and 'glass_glass'. Used for cell and module temperature calculations.
148+
module_type : string, default `glass_polymer`
149+
Describes the module's construction. Valid strings are `glass_polymer`
150+
and `glass_glass`. Used for cell and module temperature calculations.
151151
152152
module_parameters : dict or Series, optional
153153
Module parameters as defined by the SAPM, CEC, or other.
154154
155155
temperature_model_parameters : dict or Series, optional
156156
Temperature model parameters as required by one of the models in
157-
pvlib.temperature (excluding poa_global, temp_air and wind_speed).
157+
py:func:`pvlib.temperature` (excluding ``poa_global``, ``temp_air`` and
158+
``wind_speed``).
158159
159160
modules_per_string: int or float, default 1
160161
See system topology discussion above.
@@ -170,8 +171,9 @@ class PVSystem:
170171
inverter_parameters : dict or Series, optional
171172
Inverter parameters as defined by the SAPM, CEC, or other.
172173
173-
racking_model : string, default 'open_rack'
174-
Valid strings are 'open_rack', 'close_mount', and 'insulated_back'.
174+
racking_model : string, default None
175+
Valid strings are ``open_rack``, ``close_mount``, and
176+
``insulated_back``.
175177
Used to identify a parameter set for the SAPM cell temperature model.
176178
177179
losses_parameters : dict or Series, optional
@@ -1373,7 +1375,7 @@ class FixedMount(AbstractMount):
13731375
Azimuth angle of the module surface. North=0, East=90, South=180,
13741376
West=270. [degrees]
13751377
1376-
racking_model : str, optional
1378+
racking_model : str, optional, default None
13771379
Valid strings are 'open_rack', 'close_mount', and 'insulated_back'.
13781380
Used to identify a parameter set for the SAPM cell temperature model.
13791381
@@ -1450,7 +1452,7 @@ class SingleAxisTrackerMount(AbstractMount):
14501452
:func:`~pvlib.tracking.calc_cross_axis_tilt` to calculate
14511453
`cross_axis_tilt`. [degrees]
14521454
1453-
racking_model : str, optional
1455+
racking_model : str, optional, default None
14541456
Valid strings are 'open_rack', 'close_mount', and 'insulated_back'.
14551457
Used to identify a parameter set for the SAPM cell temperature model.
14561458

0 commit comments

Comments
 (0)