Merge branch 'main' into clearsky-timezone

pvlib · May 23, 2024 · f4d42e8 · f4d42e8
2 parents b00a2d4 + 80761af
commit f4d42e8
Show file tree

Hide file tree

Showing 7 changed files with 94 additions and 89 deletions.
diff --git a/docs/sphinx/source/conf.py b/docs/sphinx/source/conf.py
@@ -56,6 +56,9 @@
     'sphinx_toggleprompt',
 ]
 
+mathjax3_config = {'chtml': {'displayAlign': 'left',
+                             'displayIndent': '2em'}}
+
 napoleon_use_rtype = False  # group rtype on same line together with return
 
 # Add any paths that contain templates here, relative to this directory.

diff --git a/docs/sphinx/source/whatsnew/v0.11.0.rst b/docs/sphinx/source/whatsnew/v0.11.0.rst
@@ -29,12 +29,13 @@ Testing
 
 Documentation
 ~~~~~~~~~~~~~
-
+* Configure mathjax to left-align and indent equations in docstrings. (:pull:`2056`)
 
 Requirements
 ~~~~~~~~~~~~
 
 
 Contributors
 ~~~~~~~~~~~~
-* Yunho Kee (:ghuser:`yhkee0404`)
+* Yunho Kee (:ghuser:`yhkee0404`)
+* Cliff Hansen (:ghuser:`cwhanse`)
diff --git a/pvlib/iam.py b/pvlib/iam.py
@@ -592,10 +592,10 @@ def marion_diffuse(model, surface_tilt, **kwargs):
     iam : dict
         IAM values for each type of diffuse irradiance:
 
-            * 'sky': radiation from the sky dome (zenith <= 90)
-            * 'horizon': radiation from the region of the sky near the horizon
-              (89.5 <= zenith <= 90)
-            * 'ground': radiation reflected from the ground (zenith >= 90)
+        * 'sky': radiation from the sky dome (zenith <= 90)
+        * 'horizon': radiation from the region of the sky near the horizon
+          (89.5 <= zenith <= 90)
+        * 'ground': radiation reflected from the ground (zenith >= 90)
 
         See [1]_ for a detailed description of each class.
 
@@ -667,19 +667,19 @@ def marion_integrate(function, surface_tilt, region, num=None):
     region : {'sky', 'horizon', 'ground'}
         The region to integrate over. Must be one of:
 
-            * 'sky': radiation from the sky dome (zenith <= 90)
-            * 'horizon': radiation from the region of the sky near the horizon
-              (89.5 <= zenith <= 90)
-            * 'ground': radiation reflected from the ground (zenith >= 90)
+        * 'sky': radiation from the sky dome (zenith <= 90)
+        * 'horizon': radiation from the region of the sky near the horizon
+          (89.5 <= zenith <= 90)
+        * 'ground': radiation reflected from the ground (zenith >= 90)
 
         See [1]_ for a detailed description of each class.
 
     num : int, optional
         The number of increments in the zenith integration.
         If not specified, N will follow the values used in [1]_:
 
-            * 'sky' or 'ground': num = 180
-            * 'horizon': num = 1800
+        * 'sky' or 'ground': num = 180
+        * 'horizon': num = 1800
 
     Returns
     -------
@@ -1107,14 +1107,14 @@ def convert(source_name, source_params, target_name, weight=_sin_weight,
     source_params : dict
         A dictionary of parameters for the source model.
 
-            If source model is ``'ashrae'``, the dictionary must contain
-            the key ``'b'``.
+        If source model is ``'ashrae'``, the dictionary must contain
+        the key ``'b'``.
 
-            If source model is ``'martin_ruiz'``, the dictionary must
-            contain the key ``'a_r'``.
+        If source model is ``'martin_ruiz'``, the dictionary must
+        contain the key ``'a_r'``.
 
-            If source model is ``'physical'``, the dictionary must
-            contain the keys ``'n'``, ``'K'``, and ``'L'``.
+        If source model is ``'physical'``, the dictionary must
+        contain the keys ``'n'``, ``'K'``, and ``'L'``.
 
     target_name : str
         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,
     dict
         Parameters for the target model.
 
-            If target model is ``'ashrae'``, the dictionary will contain
-            the key ``'b'``.
+        If target model is ``'ashrae'``, the dictionary will contain
+        the key ``'b'``.
 
-            If target model is ``'martin_ruiz'``, the dictionary will
-            contain the key ``'a_r'``.
+        If target model is ``'martin_ruiz'``, the dictionary will
+        contain the key ``'a_r'``.
 
-            If target model is ``'physical'``, the dictionary will
-            contain the keys ``'n'``, ``'K'``, and ``'L'``.
+        If target model is ``'physical'``, the dictionary will
+        contain the keys ``'n'``, ``'K'``, and ``'L'``.
 
     Note
     ----
@@ -1243,14 +1243,14 @@ def fit(measured_aoi, measured_iam, model_name, weight=_sin_weight, xtol=None):
     dict
         Parameters for target model.
 
-            If target model is ``'ashrae'``, the dictionary will contain
-            the key ``'b'``.
+        If target model is ``'ashrae'``, the dictionary will contain
+        the key ``'b'``.
 
-            If target model is ``'martin_ruiz'``, the dictionary will
-            contain the key ``'a_r'``.
+        If target model is ``'martin_ruiz'``, the dictionary will
+        contain the key ``'a_r'``.
 
-            If target model is ``'physical'``, the dictionary will
-            contain the keys ``'n'``, ``'K'``, and ``'L'``.
+        If target model is ``'physical'``, the dictionary will
+        contain the keys ``'n'``, ``'K'``, and ``'L'``.
 
     References
     ----------

diff --git a/pvlib/irradiance.py b/pvlib/irradiance.py
@@ -902,8 +902,8 @@ def reindl(surface_tilt, surface_azimuth, dhi, dni, ghi, dni_extra,
 
     .. math::
 
-       I_{d} = DHI (A R_b + (1 - A) (\frac{1 + \cos\beta}{2})
-       (1 + \sqrt{\frac{I_{hb}}{I_h}} \sin^3(\beta/2)) )
+       I_{d} = DHI \left(A R_b + (1 - A) \left(\frac{1 + \cos\beta}{2}\right)
+       \left(1 + \sqrt{\frac{I_{hb}}{I_h}} \sin^3(\beta/2)\right) \right)
 
     Reindl's 1990 model determines the diffuse irradiance from the sky
     (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,
     data : DataFrame
         Contains the following keys/columns:
 
-            * ``ghi``: the modeled global horizontal irradiance in W/m^2.
-            * ``dni``: the modeled direct normal irradiance in W/m^2.
-            * ``dhi``: the modeled diffuse horizontal irradiance in
-              W/m^2.
+        * ``ghi``: the modeled global horizontal irradiance in W/m^2.
+        * ``dni``: the modeled direct normal irradiance in W/m^2.
+        * ``dhi``: the modeled diffuse horizontal irradiance in
+          W/m^2.
 
     References
     ----------
@@ -2624,11 +2624,11 @@ def erbs(ghi, zenith, datetime_or_doy, min_cos_zenith=0.065, max_zenith=87):
     data : OrderedDict or DataFrame
         Contains the following keys/columns:
 
-            * ``dni``: the modeled direct normal irradiance in W/m^2.
-            * ``dhi``: the modeled diffuse horizontal irradiance in
-              W/m^2.
-            * ``kt``: Ratio of global to extraterrestrial irradiance
-              on a horizontal plane.
+        * ``dni``: the modeled direct normal irradiance in W/m^2.
+        * ``dhi``: the modeled diffuse horizontal irradiance in
+          W/m^2.
+        * ``kt``: Ratio of global to extraterrestrial irradiance
+          on a horizontal plane.
 
     References
     ----------
@@ -2727,11 +2727,11 @@ def erbs_driesse(ghi, zenith, datetime_or_doy=None, dni_extra=None,
     data : OrderedDict or DataFrame
         Contains the following keys/columns:
 
-            * ``dni``: the modeled direct normal irradiance in W/m^2.
-            * ``dhi``: the modeled diffuse horizontal irradiance in
-              W/m^2.
-            * ``kt``: Ratio of global to extraterrestrial irradiance
-              on a horizontal plane.
+        * ``dni``: the modeled direct normal irradiance in W/m^2.
+        * ``dhi``: the modeled diffuse horizontal irradiance in
+          W/m^2.
+        * ``kt``: Ratio of global to extraterrestrial irradiance
+          on a horizontal plane.
 
     Raises
     ------
@@ -2845,11 +2845,11 @@ def orgill_hollands(ghi, zenith, datetime_or_doy, dni_extra=None,
     data : OrderedDict or DataFrame
         Contains the following keys/columns:
 
-            * ``dni``: the modeled direct normal irradiance in W/m^2.
-            * ``dhi``: the modeled diffuse horizontal irradiance in
-              W/m^2.
-            * ``kt``: Ratio of global to extraterrestrial irradiance
-              on a horizontal plane.
+        * ``dni``: the modeled direct normal irradiance in W/m^2.
+        * ``dhi``: the modeled diffuse horizontal irradiance in
+          W/m^2.
+        * ``kt``: Ratio of global to extraterrestrial irradiance
+          on a horizontal plane.
 
     References
     ----------
@@ -2940,11 +2940,11 @@ def boland(ghi, solar_zenith, datetime_or_doy, a_coeff=8.645, b_coeff=0.613,
     data : OrderedDict or DataFrame
         Contains the following keys/columns:
 
-            * ``dni``: the modeled direct normal irradiance in W/m^2.
-            * ``dhi``: the modeled diffuse horizontal irradiance in
-              W/m^2.
-            * ``kt``: Ratio of global to extraterrestrial irradiance
-              on a horizontal plane.
+        * ``dni``: the modeled direct normal irradiance in W/m^2.
+        * ``dhi``: the modeled diffuse horizontal irradiance in
+          W/m^2.
+        * ``kt``: Ratio of global to extraterrestrial irradiance
+          on a horizontal plane.
 
     References
     ----------
@@ -3777,11 +3777,11 @@ def louche(ghi, solar_zenith, datetime_or_doy, max_zenith=90):
     data: OrderedDict or DataFrame
         Contains the following keys/columns:
 
-            * ``dni``: the modeled direct normal irradiance in W/m^2.
-            * ``dhi``: the modeled diffuse horizontal irradiance in
-              W/m^2.
-            * ``kt``: Ratio of global to extraterrestrial irradiance
-              on a horizontal plane.
+        * ``dni``: the modeled direct normal irradiance in W/m^2.
+        * ``dhi``: the modeled diffuse horizontal irradiance in
+          W/m^2.
+        * ``kt``: Ratio of global to extraterrestrial irradiance
+          on a horizontal plane.
 
     References
     -------

diff --git a/pvlib/pvsystem.py b/pvlib/pvsystem.py
@@ -2318,9 +2318,10 @@ def sapm_effective_irradiance(poa_direct, poa_diffuse, airmass_absolute, aoi,
     a module's cells.
 
     The model is
+
     .. math::
 
-        `Ee = f_1(AM_a) (E_b f_2(AOI) + f_d E_d)`
+        Ee = f_1(AM_a) (E_b f_2(AOI) + f_d E_d)
 
     where :math:`Ee` is effective irradiance (W/m2), :math:`f_1` is a fourth
     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,
     dict or pandas.DataFrame
         The returned dict-like object always contains the keys/columns:
 
-            * i_sc - short circuit current in amperes.
-            * v_oc - open circuit voltage in volts.
-            * i_mp - current at maximum power point in amperes.
-            * v_mp - voltage at maximum power point in volts.
-            * p_mp - power at maximum power point in watts.
-            * i_x - current, in amperes, at ``v = 0.5*v_oc``.
-            * i_xx - current, in amperes, at ``v = 0.5*(v_oc+v_mp)``.
+        * i_sc - short circuit current in amperes.
+        * v_oc - open circuit voltage in volts.
+        * i_mp - current at maximum power point in amperes.
+        * v_mp - voltage at maximum power point in volts.
+        * p_mp - power at maximum power point in watts.
+        * i_x - current, in amperes, at ``v = 0.5*v_oc``.
+        * i_xx - current, in amperes, at ``v = 0.5*(v_oc+v_mp)``.
 
         A dict is returned when the input parameters are scalars or
         ``ivcurve_pnts > 0``. If ``ivcurve_pnts > 0``, the output dictionary
         will also include the keys:
 
-            * i - IV curve current in amperes.
-            * v - IV curve voltage in volts.
+        * i - IV curve current in amperes.
+        * v - IV curve voltage in volts.
 
     See also
     --------

diff --git a/pvlib/spectrum/mismatch.py b/pvlib/spectrum/mismatch.py
@@ -265,11 +265,11 @@ def spectral_factor_firstsolar(precipitable_water, airmass_absolute,
     SMARTS, spectrums are simulated with all combinations of AMa and
     Pw where:
 
-       * :math:`0.5 \textrm{cm} <= Pw <= 5 \textrm{cm}`
-       * :math:`1.0 <= AM_a <= 5.0`
-       * Spectral range is limited to that of CMP11 (280 nm to 2800 nm)
-       * spectrum simulated on a plane normal to the sun
-       * All other parameters fixed at G173 standard
+    * :math:`0.5 \textrm{cm} <= Pw <= 5 \textrm{cm}`
+    * :math:`1.0 <= AM_a <= 5.0`
+    * Spectral range is limited to that of CMP11 (280 nm to 2800 nm)
+    * spectrum simulated on a plane normal to the sun
+    * All other parameters fixed at G173 standard
 
     From these simulated spectra, M is calculated using the known
     quantum efficiency curves. Multiple linear regression is then
@@ -291,11 +291,11 @@ def spectral_factor_firstsolar(precipitable_water, airmass_absolute,
         'multisi', and 'polysi' (can be lower or upper case). If provided,
         module_type selects default coefficients for the following modules:
 
-            * 'cdte' - First Solar Series 4-2 CdTe module.
-            * 'monosi', 'xsi' - First Solar TetraSun module.
-            * 'multisi', 'polysi' - anonymous multi-crystalline silicon module.
-            * 'cigs' - anonymous copper indium gallium selenide module.
-            * 'asi' - anonymous amorphous silicon module.
+        * 'cdte' - First Solar Series 4-2 CdTe module.
+        * 'monosi', 'xsi' - First Solar TetraSun module.
+        * 'multisi', 'polysi' - anonymous multi-crystalline silicon module.
+        * 'cigs' - anonymous copper indium gallium selenide module.
+        * 'asi' - anonymous amorphous silicon module.
 
         The module used to calculate the spectral correction
         coefficients corresponds to the Multi-crystalline silicon

diff --git a/pvlib/spectrum/spectrl2.py b/pvlib/spectrum/spectrl2.py
@@ -233,14 +233,14 @@ def spectrl2(apparent_zenith, aoi, surface_tilt, ground_albedo,
         input ``apparent_zenith``.  All values are spectral irradiance
         with units W/m^2/nm except for `wavelength`, which is in nanometers.
 
-            * wavelength
-            * dni_extra
-            * dhi
-            * dni
-            * poa_sky_diffuse
-            * poa_ground_diffuse
-            * poa_direct
-            * poa_global
+        * wavelength
+        * dni_extra
+        * dhi
+        * dni
+        * poa_sky_diffuse
+        * poa_ground_diffuse
+        * poa_direct
+        * poa_global
 
     Notes
     -----