Skip to content

Commit 7bb7e02

Browse files
yhkee0404yhkee0404
committed
Merge branch 'main' into clearsky-timezone
2 parents b00a2d4 + 80761af commit 7bb7e02

File tree

7 files changed

+96
-89
lines changed

7 files changed

+96
-89
lines changed

‎docs/sphinx/source/conf.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,9 @@
5656
'sphinx_toggleprompt',
5757
]
5858

59+
mathjax3_config = {'chtml': {'displayAlign': 'left',
60+
'displayIndent': '2em'}}
61+
5962
napoleon_use_rtype = False # group rtype on same line together with return
6063

6164
# Add any paths that contain templates here, relative to this directory.

‎docs/sphinx/source/whatsnew/v0.11.0.rst

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,12 +29,15 @@ Testing
2929

3030
Documentation
3131
~~~~~~~~~~~~~
32-
32+
* Configure mathjax to left-align and indent equations in docstrings. (:pull:`2056`)
3333

3434
Requirements
3535
~~~~~~~~~~~~
3636

3737

3838
Contributors
3939
~~~~~~~~~~~~
40-
* Yunho Kee (:ghuser:`yhkee0404`)
40+
* Cliff Hansen (:ghuser:`cwhanse`)
41+
* Mark Mikofski (:ghuser:`mikofski`)
42+
* Siddharth Kaul (:ghuser:`k10blogger`)
43+
* Yunho Kee (:ghuser:`yhkee0404`)

‎pvlib/iam.py

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -592,10 +592,10 @@ def marion_diffuse(model, surface_tilt, **kwargs):
592592
iam : dict
593593
IAM values for each type of diffuse irradiance:
594594
595-
* 'sky': radiation from the sky dome (zenith <= 90)
596-
* 'horizon': radiation from the region of the sky near the horizon
597-
(89.5 <= zenith <= 90)
598-
* 'ground': radiation reflected from the ground (zenith >= 90)
595+
* 'sky': radiation from the sky dome (zenith <= 90)
596+
* 'horizon': radiation from the region of the sky near the horizon
597+
(89.5 <= zenith <= 90)
598+
* 'ground': radiation reflected from the ground (zenith >= 90)
599599
600600
See [1]_ for a detailed description of each class.
601601
@@ -667,19 +667,19 @@ def marion_integrate(function, surface_tilt, region, num=None):
667667
region : {'sky', 'horizon', 'ground'}
668668
The region to integrate over. Must be one of:
669669
670-
* 'sky': radiation from the sky dome (zenith <= 90)
671-
* 'horizon': radiation from the region of the sky near the horizon
672-
(89.5 <= zenith <= 90)
673-
* 'ground': radiation reflected from the ground (zenith >= 90)
670+
* 'sky': radiation from the sky dome (zenith <= 90)
671+
* 'horizon': radiation from the region of the sky near the horizon
672+
(89.5 <= zenith <= 90)
673+
* 'ground': radiation reflected from the ground (zenith >= 90)
674674
675675
See [1]_ for a detailed description of each class.
676676
677677
num : int, optional
678678
The number of increments in the zenith integration.
679679
If not specified, N will follow the values used in [1]_:
680680
681-
* 'sky' or 'ground': num = 180
682-
* 'horizon': num = 1800
681+
* 'sky' or 'ground': num = 180
682+
* 'horizon': num = 1800
683683
684684
Returns
685685
-------
@@ -1107,14 +1107,14 @@ def convert(source_name, source_params, target_name, weight=_sin_weight,
11071107
source_params : dict
11081108
A dictionary of parameters for the source model.
11091109
1110-
If source model is ``'ashrae'``, the dictionary must contain
1111-
the key ``'b'``.
1110+
If source model is ``'ashrae'``, the dictionary must contain
1111+
the key ``'b'``.
11121112
1113-
If source model is ``'martin_ruiz'``, the dictionary must
1114-
contain the key ``'a_r'``.
1113+
If source model is ``'martin_ruiz'``, the dictionary must
1114+
contain the key ``'a_r'``.
11151115
1116-
If source model is ``'physical'``, the dictionary must
1117-
contain the keys ``'n'``, ``'K'``, and ``'L'``.
1116+
If source model is ``'physical'``, the dictionary must
1117+
contain the keys ``'n'``, ``'K'``, and ``'L'``.
11181118
11191119
target_name : str
11201120
Name of the target model. Must be ``'ashrae'``, ``'martin_ruiz'``, or
@@ -1146,14 +1146,14 @@ def convert(source_name, source_params, target_name, weight=_sin_weight,
11461146
dict
11471147
Parameters for the target model.
11481148
1149-
If target model is ``'ashrae'``, the dictionary will contain
1150-
the key ``'b'``.
1149+
If target model is ``'ashrae'``, the dictionary will contain
1150+
the key ``'b'``.
11511151
1152-
If target model is ``'martin_ruiz'``, the dictionary will
1153-
contain the key ``'a_r'``.
1152+
If target model is ``'martin_ruiz'``, the dictionary will
1153+
contain the key ``'a_r'``.
11541154
1155-
If target model is ``'physical'``, the dictionary will
1156-
contain the keys ``'n'``, ``'K'``, and ``'L'``.
1155+
If target model is ``'physical'``, the dictionary will
1156+
contain the keys ``'n'``, ``'K'``, and ``'L'``.
11571157
11581158
Note
11591159
----
@@ -1243,14 +1243,14 @@ def fit(measured_aoi, measured_iam, model_name, weight=_sin_weight, xtol=None):
12431243
dict
12441244
Parameters for target model.
12451245
1246-
If target model is ``'ashrae'``, the dictionary will contain
1247-
the key ``'b'``.
1246+
If target model is ``'ashrae'``, the dictionary will contain
1247+
the key ``'b'``.
12481248
1249-
If target model is ``'martin_ruiz'``, the dictionary will
1250-
contain the key ``'a_r'``.
1249+
If target model is ``'martin_ruiz'``, the dictionary will
1250+
contain the key ``'a_r'``.
12511251
1252-
If target model is ``'physical'``, the dictionary will
1253-
contain the keys ``'n'``, ``'K'``, and ``'L'``.
1252+
If target model is ``'physical'``, the dictionary will
1253+
contain the keys ``'n'``, ``'K'``, and ``'L'``.
12541254
12551255
References
12561256
----------

‎pvlib/irradiance.py

Lines changed: 31 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -902,8 +902,8 @@ def reindl(surface_tilt, surface_azimuth, dhi, dni, ghi, dni_extra,
902902
903903
.. math::
904904
905-
I_{d} = DHI (A R_b + (1 - A) (\frac{1 + \cos\beta}{2})
906-
(1 + \sqrt{\frac{I_{hb}}{I_h}} \sin^3(\beta/2)) )
905+
I_{d} = DHI \left(A R_b + (1 - A) \left(\frac{1 + \cos\beta}{2}\right)
906+
\left(1 + \sqrt{\frac{I_{hb}}{I_h}} \sin^3(\beta/2)\right) \right)
907907
908908
Reindl's 1990 model determines the diffuse irradiance from the sky
909909
(ground reflected irradiance is not included in this algorithm) on a
@@ -2340,10 +2340,10 @@ def gti_dirint(poa_global, aoi, solar_zenith, solar_azimuth, times,
23402340
data : DataFrame
23412341
Contains the following keys/columns:
23422342
2343-
* ``ghi``: the modeled global horizontal irradiance in W/m^2.
2344-
* ``dni``: the modeled direct normal irradiance in W/m^2.
2345-
* ``dhi``: the modeled diffuse horizontal irradiance in
2346-
W/m^2.
2343+
* ``ghi``: the modeled global horizontal irradiance in W/m^2.
2344+
* ``dni``: the modeled direct normal irradiance in W/m^2.
2345+
* ``dhi``: the modeled diffuse horizontal irradiance in
2346+
W/m^2.
23472347
23482348
References
23492349
----------
@@ -2624,11 +2624,11 @@ def erbs(ghi, zenith, datetime_or_doy, min_cos_zenith=0.065, max_zenith=87):
26242624
data : OrderedDict or DataFrame
26252625
Contains the following keys/columns:
26262626
2627-
* ``dni``: the modeled direct normal irradiance in W/m^2.
2628-
* ``dhi``: the modeled diffuse horizontal irradiance in
2629-
W/m^2.
2630-
* ``kt``: Ratio of global to extraterrestrial irradiance
2631-
on a horizontal plane.
2627+
* ``dni``: the modeled direct normal irradiance in W/m^2.
2628+
* ``dhi``: the modeled diffuse horizontal irradiance in
2629+
W/m^2.
2630+
* ``kt``: Ratio of global to extraterrestrial irradiance
2631+
on a horizontal plane.
26322632
26332633
References
26342634
----------
@@ -2727,11 +2727,11 @@ def erbs_driesse(ghi, zenith, datetime_or_doy=None, dni_extra=None,
27272727
data : OrderedDict or DataFrame
27282728
Contains the following keys/columns:
27292729
2730-
* ``dni``: the modeled direct normal irradiance in W/m^2.
2731-
* ``dhi``: the modeled diffuse horizontal irradiance in
2732-
W/m^2.
2733-
* ``kt``: Ratio of global to extraterrestrial irradiance
2734-
on a horizontal plane.
2730+
* ``dni``: the modeled direct normal irradiance in W/m^2.
2731+
* ``dhi``: the modeled diffuse horizontal irradiance in
2732+
W/m^2.
2733+
* ``kt``: Ratio of global to extraterrestrial irradiance
2734+
on a horizontal plane.
27352735
27362736
Raises
27372737
------
@@ -2845,11 +2845,11 @@ def orgill_hollands(ghi, zenith, datetime_or_doy, dni_extra=None,
28452845
data : OrderedDict or DataFrame
28462846
Contains the following keys/columns:
28472847
2848-
* ``dni``: the modeled direct normal irradiance in W/m^2.
2849-
* ``dhi``: the modeled diffuse horizontal irradiance in
2850-
W/m^2.
2851-
* ``kt``: Ratio of global to extraterrestrial irradiance
2852-
on a horizontal plane.
2848+
* ``dni``: the modeled direct normal irradiance in W/m^2.
2849+
* ``dhi``: the modeled diffuse horizontal irradiance in
2850+
W/m^2.
2851+
* ``kt``: Ratio of global to extraterrestrial irradiance
2852+
on a horizontal plane.
28532853
28542854
References
28552855
----------
@@ -2940,11 +2940,11 @@ def boland(ghi, solar_zenith, datetime_or_doy, a_coeff=8.645, b_coeff=0.613,
29402940
data : OrderedDict or DataFrame
29412941
Contains the following keys/columns:
29422942
2943-
* ``dni``: the modeled direct normal irradiance in W/m^2.
2944-
* ``dhi``: the modeled diffuse horizontal irradiance in
2945-
W/m^2.
2946-
* ``kt``: Ratio of global to extraterrestrial irradiance
2947-
on a horizontal plane.
2943+
* ``dni``: the modeled direct normal irradiance in W/m^2.
2944+
* ``dhi``: the modeled diffuse horizontal irradiance in
2945+
W/m^2.
2946+
* ``kt``: Ratio of global to extraterrestrial irradiance
2947+
on a horizontal plane.
29482948
29492949
References
29502950
----------
@@ -3777,11 +3777,11 @@ def louche(ghi, solar_zenith, datetime_or_doy, max_zenith=90):
37773777
data: OrderedDict or DataFrame
37783778
Contains the following keys/columns:
37793779
3780-
* ``dni``: the modeled direct normal irradiance in W/m^2.
3781-
* ``dhi``: the modeled diffuse horizontal irradiance in
3782-
W/m^2.
3783-
* ``kt``: Ratio of global to extraterrestrial irradiance
3784-
on a horizontal plane.
3780+
* ``dni``: the modeled direct normal irradiance in W/m^2.
3781+
* ``dhi``: the modeled diffuse horizontal irradiance in
3782+
W/m^2.
3783+
* ``kt``: Ratio of global to extraterrestrial irradiance
3784+
on a horizontal plane.
37853785
37863786
References
37873787
-------

‎pvlib/pvsystem.py

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2318,9 +2318,10 @@ def sapm_effective_irradiance(poa_direct, poa_diffuse, airmass_absolute, aoi,
23182318
a module's cells.
23192319
23202320
The model is
2321+
23212322
.. math::
23222323
2323-
`Ee = f_1(AM_a) (E_b f_2(AOI) + f_d E_d)`
2324+
Ee = f_1(AM_a) (E_b f_2(AOI) + f_d E_d)
23242325
23252326
where :math:`Ee` is effective irradiance (W/m2), :math:`f_1` is a fourth
23262327
degree polynomial in air mass :math:`AM_a`, :math:`E_b` is beam (direct)
@@ -2420,20 +2421,20 @@ def singlediode(photocurrent, saturation_current, resistance_series,
24202421
dict or pandas.DataFrame
24212422
The returned dict-like object always contains the keys/columns:
24222423
2423-
* i_sc - short circuit current in amperes.
2424-
* v_oc - open circuit voltage in volts.
2425-
* i_mp - current at maximum power point in amperes.
2426-
* v_mp - voltage at maximum power point in volts.
2427-
* p_mp - power at maximum power point in watts.
2428-
* i_x - current, in amperes, at ``v = 0.5*v_oc``.
2429-
* i_xx - current, in amperes, at ``v = 0.5*(v_oc+v_mp)``.
2424+
* i_sc - short circuit current in amperes.
2425+
* v_oc - open circuit voltage in volts.
2426+
* i_mp - current at maximum power point in amperes.
2427+
* v_mp - voltage at maximum power point in volts.
2428+
* p_mp - power at maximum power point in watts.
2429+
* i_x - current, in amperes, at ``v = 0.5*v_oc``.
2430+
* i_xx - current, in amperes, at ``v = 0.5*(v_oc+v_mp)``.
24302431
24312432
A dict is returned when the input parameters are scalars or
24322433
``ivcurve_pnts > 0``. If ``ivcurve_pnts > 0``, the output dictionary
24332434
will also include the keys:
24342435
2435-
* i - IV curve current in amperes.
2436-
* v - IV curve voltage in volts.
2436+
* i - IV curve current in amperes.
2437+
* v - IV curve voltage in volts.
24372438
24382439
See also
24392440
--------

‎pvlib/spectrum/mismatch.py

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -265,11 +265,11 @@ def spectral_factor_firstsolar(precipitable_water, airmass_absolute,
265265
SMARTS, spectrums are simulated with all combinations of AMa and
266266
Pw where:
267267
268-
* :math:`0.5 \textrm{cm} <= Pw <= 5 \textrm{cm}`
269-
* :math:`1.0 <= AM_a <= 5.0`
270-
* Spectral range is limited to that of CMP11 (280 nm to 2800 nm)
271-
* spectrum simulated on a plane normal to the sun
272-
* All other parameters fixed at G173 standard
268+
* :math:`0.5 \textrm{cm} <= Pw <= 5 \textrm{cm}`
269+
* :math:`1.0 <= AM_a <= 5.0`
270+
* Spectral range is limited to that of CMP11 (280 nm to 2800 nm)
271+
* spectrum simulated on a plane normal to the sun
272+
* All other parameters fixed at G173 standard
273273
274274
From these simulated spectra, M is calculated using the known
275275
quantum efficiency curves. Multiple linear regression is then
@@ -291,11 +291,11 @@ def spectral_factor_firstsolar(precipitable_water, airmass_absolute,
291291
'multisi', and 'polysi' (can be lower or upper case). If provided,
292292
module_type selects default coefficients for the following modules:
293293
294-
* 'cdte' - First Solar Series 4-2 CdTe module.
295-
* 'monosi', 'xsi' - First Solar TetraSun module.
296-
* 'multisi', 'polysi' - anonymous multi-crystalline silicon module.
297-
* 'cigs' - anonymous copper indium gallium selenide module.
298-
* 'asi' - anonymous amorphous silicon module.
294+
* 'cdte' - First Solar Series 4-2 CdTe module.
295+
* 'monosi', 'xsi' - First Solar TetraSun module.
296+
* 'multisi', 'polysi' - anonymous multi-crystalline silicon module.
297+
* 'cigs' - anonymous copper indium gallium selenide module.
298+
* 'asi' - anonymous amorphous silicon module.
299299
300300
The module used to calculate the spectral correction
301301
coefficients corresponds to the Multi-crystalline silicon

‎pvlib/spectrum/spectrl2.py

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -233,14 +233,14 @@ def spectrl2(apparent_zenith, aoi, surface_tilt, ground_albedo,
233233
input ``apparent_zenith``. All values are spectral irradiance
234234
with units W/m^2/nm except for `wavelength`, which is in nanometers.
235235
236-
* wavelength
237-
* dni_extra
238-
* dhi
239-
* dni
240-
* poa_sky_diffuse
241-
* poa_ground_diffuse
242-
* poa_direct
243-
* poa_global
236+
* wavelength
237+
* dni_extra
238+
* dhi
239+
* dni
240+
* poa_sky_diffuse
241+
* poa_ground_diffuse
242+
* poa_direct
243+
* poa_global
244244
245245
Notes
246246
-----

0 commit comments

Comments
 (0)