|
19 | 19 | from pvlib.tools import _build_kwargs |
20 | 20 |
|
21 | 21 | from pvlib._deprecation import deprecated |
| 22 | +# Keys used to detect input data and assign values to the appropriate |
| 23 | +# ModelChain attributes. |
22 | 24 |
|
23 | | -# keys that are used to detect input data and assign data to appropriate |
24 | | -# ModelChain attribute |
25 | | - |
26 | | -# For ModelChain.weather: |
27 | | -# Maps weather-related input columns to the weather DataFrame. |
28 | | -#: list[str]: Required or optional weather input columns. |
| 25 | +#: tuple[str] |
| 26 | +#: Weather-related input columns used by :class:`ModelChain` to populate |
| 27 | +#: ``ModelChain.weather``. Missing ``temp_air`` or ``wind_speed`` are |
| 28 | +#: automatically filled (20 °C and 0 m/s). |
29 | 29 | WEATHER_KEYS = ( |
30 | 30 | 'ghi', # Global Horizontal Irradiance (W/m^2) |
31 | 31 | 'dhi', # Diffuse Horizontal Irradiance (W/m^2) |
|
35 | 35 | 'precipitable_water' # Column precipitable water (cm) |
36 | 36 | ) |
37 | 37 |
|
38 | | -# For ModelChain.total_irrad: |
39 | | -# Plane-of-array irradiance components. |
40 | | -#: list[str]: Required POA irradiance input columns. |
| 38 | +#: tuple[str] |
| 39 | +#: Plane-of-array irradiance components used to populate |
| 40 | +#: ``ModelChain.total_irrad`` when running from POA input. |
41 | 41 | POA_KEYS = ( |
42 | 42 | 'poa_global', # Total plane-of-array irradiance (W/m^2) |
43 | | - 'poa_direct', # Direct normal POA irradiance (W/m^2) |
| 43 | + 'poa_direct', # Direct POA irradiance (W/m^2) |
44 | 44 | 'poa_diffuse' # Diffuse POA irradiance (W/m^2) |
45 | 45 | ) |
46 | 46 |
|
47 | | -# Optional keys for temperature-specific inputs. |
48 | | -# These override or supplement temperature models. |
49 | | -#: list[str]: Temperature-related input columns. |
| 47 | +#: tuple[str] |
| 48 | +#: Temperature-related input columns that override or supplement the |
| 49 | +#: ModelChain temperature model. If ``cell_temperature`` is provided, |
| 50 | +#: the temperature model is skipped. |
50 | 51 | TEMPERATURE_KEYS = ( |
51 | 52 | 'module_temperature', # Back-surface module temperature (°C) |
52 | 53 | 'cell_temperature', # Direct cell temperature input (°C) |
53 | 54 | ) |
| 55 | +#: tuple[str] |
| 56 | +#: All supported input keys recognized by ModelChain. |
54 | 57 | DATA_KEYS = WEATHER_KEYS + POA_KEYS + TEMPERATURE_KEYS |
55 | | - |
56 | 58 | # these dictionaries contain the default configuration for following |
57 | 59 | # established modeling sequences. They can be used in combination with |
58 | 60 | # ModelChain, particularly they are used by the methods |
|
0 commit comments