Merge branch 'main' into move-test-files

Author: echedey-ls

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,7 +1,7 @@
 <!-- Thank you for your contribution! The following items must be addressed before the code can be merged. Please don't hesitate to ask for help if you're unsure of how to accomplish any of the items. Feel free to remove checklist items that are not relevant to your change. -->
 
  - [ ] Closes #xxxx
- - [ ] I am familiar with the [contributing guidelines](https://pvlib-python.readthedocs.io/en/latest/contributing.html)
+ - [ ] I am familiar with the [contributing guidelines](https://pvlib-python.readthedocs.io/en/latest/contributing/index.html)
  - [ ] Tests added
  - [ ] Updates entries in [`docs/sphinx/source/reference`](https://github.com/pvlib/pvlib-python/blob/main/docs/sphinx/source/reference) for API changes.
  - [ ] Adds description and name entries in the appropriate "what's new" file in [`docs/sphinx/source/whatsnew`](https://github.com/pvlib/pvlib-python/tree/main/docs/sphinx/source/whatsnew) for all changes. Includes link to the GitHub Issue with `` :issue:`num` `` or this Pull Request with `` :pull:`num` ``. Includes contributor name and/or GitHub username (link with `` :ghuser:`user` ``).

docs/examples/shading/plot_martinez_shade_loss.py

@@ -47,7 +47,7 @@
 import pandas as pd
 import numpy as np
 import matplotlib.pyplot as plt
-from matplotlib.dates import ConciseDateFormatter
+from matplotlib.dates import DateFormatter
 
 pitch = 4  # meters
 width = 1.5  # meters
@@ -235,10 +235,6 @@
     ax1.plot(times, shade_losses, label=k, linestyle=linestyle)
 ax1.legend(loc="upper center")
 ax1.grid()
-ax1.set_xlabel("Time")
-ax1.xaxis.set_major_formatter(
-    ConciseDateFormatter("%H:%M", tz="Europe/Madrid")
-)
 ax1.set_ylabel(r"$P_{out}$ losses")
 ax1.set_title("Per module")
 
@@ -248,9 +244,7 @@
 ax2.legend(loc="upper center")
 ax2.grid()
 ax2.set_xlabel("Time")
-ax2.xaxis.set_major_formatter(
-    ConciseDateFormatter("%H:%M", tz="Europe/Madrid")
-)
+ax2.xaxis.set_major_formatter(DateFormatter("%H:%M", tz="Europe/Madrid"))
 ax2.set_ylabel(r"$P_{out}$ losses")
 ax2.set_title("Per row")
 fig.tight_layout()

docs/sphinx/source/conf.py

@@ -56,11 +56,30 @@
     'sphinx_gallery.gen_gallery',
     'sphinx_toggleprompt',
     'sphinx_favicon',
+    'hoverxref.extension',
 ]
 
 mathjax3_config = {'chtml': {'displayAlign': 'left',
                              'displayIndent': '2em'}}
 
+# Example configuration for intersphinx: refer to the Python standard library.
+intersphinx_mapping = {
+    'python': ('https://docs.python.org/3/', None),
+    'numpy': ('https://numpy.org/doc/stable/', None),
+    'scipy': ('https://docs.scipy.org/doc/scipy/reference/', None),
+    'pandas': ('https://pandas.pydata.org/pandas-docs/stable', None),
+    'matplotlib': ('https://matplotlib.org/stable', None),
+}
+
+# Enable hover tooltips
+hoverxref_auto_ref = True
+hoverxref_roles = [
+    "class", "meth", "func", "ref", "term", "obj", "mod", "data"
+]
+hoverxref_role_types = dict.fromkeys(hoverxref_roles, "tooltip")
+hoverxref_domains = ["py"]
+hoverxref_intersphinx = list(intersphinx_mapping.keys())
+
 napoleon_use_rtype = False  # group rtype on same line together with return
 
 # Add any paths that contain templates here, relative to this directory.
@@ -357,15 +376,6 @@ def setup(app):
 # If true, do not generate a @detailmenu in the "Top" node's menu.
 # texinfo_no_detailmenu = False
 
-# Example configuration for intersphinx: refer to the Python standard library.
-intersphinx_mapping = {
-    'python': ('https://docs.python.org/3/', None),
-    'numpy': ('https://numpy.org/doc/stable/', None),
-    'scipy': ('https://docs.scipy.org/doc/scipy/reference/', None),
-    'pandas': ('https://pandas.pydata.org/pandas-docs/stable', None),
-    'matplotlib': ('https://matplotlib.org/stable', None),
-}
-
 ipython_warning_is_error = False
 
 # suppress "WARNING: Footnote [1] is not referenced." messages

docs/sphinx/source/contributing/how_to_contribute_new_code.rst

@@ -153,8 +153,7 @@ We strongly recommend using virtual environments for development.
 Virtual environments make it easier to switch between different
 versions of software. This `scientific-python.org guide
 <https://learn.scientific-python.org/development/tutorials/dev-environment/>`_
-is a good reference for virtual environments. The pvlib-python `installation
-user guide <https://pvlib-python.readthedocs.io/en/stable/user_guide/
-installation.html#set-up-a-virtual-environment>`_ also provides instructions on
+is a good reference for virtual environments. The pvlib-python
+:ref:`installation guide <setupenvironment>` also provides instructions on
 setting up a virtual environment. If this is your first pull request, don't
 worry about using a virtual environment.

docs/sphinx/source/contributing/index.rst

@@ -1,3 +1,5 @@
+.. _contributing:
+
 ============
 Contributing
 ============

docs/sphinx/source/contributing/style_guide.rst

@@ -70,7 +70,30 @@ the ``docs/readthedocs.org:pvlib-python`` link within the checks
 status box at the bottom of the pull request.
 
 
-.. _references:
+.. _documentation-units:
+
+Parameter names and units
+-------------------------
+
+When specifying parameters and their units, please follow these guidelines:
+
+- Use the recommended parameter name and units listed in the :ref:`nomenclature` where applicable.
+- Enclose units in square brackets after the parameter description, e.g., ``Air temperature. [°C]``.
+- Use unicode superscripts symbols for exponents, e.g. ``m⁻²``.
+
+  - Numbers: ``⁰``, ``¹``, ``²``, ``³``, ``⁴``, ``⁵``, ``⁶``, ``⁷``, ``⁸``, ``⁹``
+  - Negative exponent: ``⁻``
+  - Degree symbol: ``°``
+
+- Link to a brief description in the :ref:`nomenclature` section if it exists, via the sphinx role ``:term:`glossary_term```. For example, to document ``dni`` use:
+
+  .. code-block:: rst
+
+      dni : numeric
+          Direct normal irradiance, see :term:`dni`. [Wm⁻²]
+
+
+.. _reference_style:
 
 References
 ----------

docs/sphinx/source/reference/airmass_atmospheric.rst

@@ -11,6 +11,8 @@ Airmass and atmospheric models
    atmosphere.get_relative_airmass
    atmosphere.pres2alt
    atmosphere.alt2pres
+   atmosphere.tdew_from_rh
+   atmosphere.rh_from_tdew
    atmosphere.gueymard94_pw
    atmosphere.first_solar_spectral_correction
    atmosphere.bird_hulstrom80_aod_bb

docs/sphinx/source/reference/tracking.rst

@@ -3,9 +3,6 @@
 Tracking
 ========
 
-Functions
----------
-
 .. autosummary::
    :toctree: generated/
 

docs/sphinx/source/reference/transformer.rst

@@ -3,7 +3,7 @@
 Transformer losses
 ==================
 
-Methods to account for losses in transformers
+Functions to account for losses in transformers
 
 .. autosummary::
    :toctree: generated/

docs/sphinx/source/user_guide/nomenclature.rst

@@ -102,20 +102,21 @@ There is a convention on consistent variable names throughout the library:
         Photocurrent
 
     poa_diffuse
-        Total diffuse irradiation in plane. Sum of ground and sky diffuse.
+        Total diffuse irradiance in plane [Wm⁻²]. Sum of ground and sky diffuse
+        components of global irradiance.
 
     poa_direct
-        Direct/beam irradiation in plane
+        Direct/beam irradiance in plane [Wm⁻²].
 
     poa_global
-        Global irradiation in plane. sum of diffuse and beam projection.
+        Global irradiance in plane.  Sum of diffuse and beam projection [Wm⁻²].
 
     poa_ground_diffuse
-        In plane ground reflected irradiation
+        In plane ground reflected irradiance [Wm⁻²].
 
     poa_sky_diffuse
-        Diffuse irradiation in plane from scattered light in the atmosphere
-        (without ground reflected irradiation)
+        Diffuse irradiance in plane from scattered light in the atmosphere
+        (without ground reflected irradiance) [Wm⁻²].
 
     precipitable_water
         Total precipitable water contained in a column of unit cross section
@@ -142,6 +143,13 @@ There is a convention on consistent variable names throughout the library:
     solar_zenith
         Zenith angle of the sun in degrees
 
+    spectra
+    spectra_components
+        Spectral irradiance (components) [Wm⁻²nm⁻¹]. The amount of energy
+        incident on a unit area per unit time and per unit
+        wavelength. As with broadband irradiance, global spectral irradiance
+        is composed of direct and diffuse components.
+    
     surface_azimuth
         Azimuth angle of the surface
 
@@ -161,10 +169,6 @@ There is a convention on consistent variable names throughout the library:
     temp_module
         Temperature of the module
 
-    transposition_factor
-        The gain ratio of the radiation on inclined plane to global horizontal
-        irradiation: :math:`\frac{poa\_global}{ghi}`
-
     tz
         Timezone
 

docs/sphinx/source/user_guide/singlediode.rst

@@ -24,7 +24,7 @@ diode model equation.
 
 .. math::
 
-   I = I_L - I_0 \left(\exp \left(\frac{V + I R_s}{n Ns V_{th}} \right) - 1 \right)
+   I = I_L - I_0 \left(\exp \left(\frac{V + I R_s}{n N_s V_{th}} \right) - 1 \right)
        - \frac{V + I R_s}{R_{sh}}
 
 Lambert W-function is the inverse of the function
@@ -36,8 +36,8 @@ a form that can be expressed as a Lambert W-function.
 
 .. math::
 
-   z = \frac{R_s I_0}{n Ns V_{th} \left(1 + \frac{R_s}{R_{sh}} \right)} \exp \left(
-       \frac{R_s \left( I_L + I_0 \right) + V}{n Ns V_{th} \left(1 + \frac{R_s}{R_{sh}}\right)}
+   z = \frac{R_s I_0}{n N_s V_{th} \left(1 + \frac{R_s}{R_{sh}} \right)} \exp \left(
+       \frac{R_s \left( I_L + I_0 \right) + V}{n N_s V_{th} \left(1 + \frac{R_s}{R_{sh}}\right)}
        \right)
 
 Then the module current can be solved using the Lambert W-function,
@@ -46,7 +46,7 @@ Then the module current can be solved using the Lambert W-function,
 .. math::
 
    I = \frac{I_L + I_0 - \frac{V}{R_{sh}}}{1 + \frac{R_s}{R_{sh}}}
-       - \frac{n Ns V_{th}}{R_s} W \left(z \right)
+       - \frac{n N_s V_{th}}{R_s} W \left(z \right)
 
 
 Bishop's Algorithm
@@ -60,7 +60,7 @@ by a zero diode voltage and an estimate of open circuit voltage given by
 
 .. math::
 
-   V_{oc, est} = n Ns V_{th} \log \left( \frac{I_L}{I_0} + 1 \right)
+   V_{oc, est} = n N_s V_{th} \log \left( \frac{I_L}{I_0} + 1 \right)
 
 We know that :math:`V_d = 0` corresponds to a voltage less than zero, and
 we can also show that when :math:`V_d = V_{oc, est}`, the resulting
@@ -73,24 +73,24 @@ between 0 and :math:`V_{oc, est}` will always find any desired condition in the
 
 .. math::
 
-   I = I_L - I_0 \left(\exp \left(\frac{V_{oc, est}}{n Ns V_{th}} \right) - 1 \right)
+   I = I_L - I_0 \left(\exp \left(\frac{V_{oc, est}}{n N_s V_{th}} \right) - 1 \right)
        - \frac{V_{oc, est}}{R_{sh}} \newline
 
-   I = I_L - I_0 \left(\exp \left(\frac{n Ns V_{th} \log \left(\frac{I_L}{I_0} + 1 \right)}{n Ns V_{th}} \right) - 1 \right)
-       - \frac{n Ns V_{th} \log \left(\frac{I_L}{I_0} + 1 \right)}{R_{sh}} \newline
+   I = I_L - I_0 \left(\exp \left(\frac{n N_s V_{th} \log \left(\frac{I_L}{I_0} + 1 \right)}{n N_s V_{th}} \right) - 1 \right)
+       - \frac{n N_s V_{th} \log \left(\frac{I_L}{I_0} + 1 \right)}{R_{sh}} \newline
 
    I = I_L - I_0 \left(\exp \left(\log \left(\frac{I_L}{I_0} + 1 \right) \right)  - 1 \right)
-       - \frac{n Ns V_{th} \log \left(\frac{I_L}{I_0} + 1 \right)}{R_{sh}} \newline
+       - \frac{n N_s V_{th} \log \left(\frac{I_L}{I_0} + 1 \right)}{R_{sh}} \newline
 
    I = I_L - I_0 \left(\frac{I_L}{I_0} + 1  - 1 \right)
-       - \frac{n Ns V_{th} \log \left(\frac{I_L}{I_0} + 1 \right)}{R_{sh}} \newline
+       - \frac{n N_s V_{th} \log \left(\frac{I_L}{I_0} + 1 \right)}{R_{sh}} \newline
 
    I = I_L - I_0 \left(\frac{I_L}{I_0} \right)
-       - \frac{n Ns V_{th} \log \left(\frac{I_L}{I_0} + 1 \right)}{R_{sh}} \newline
+       - \frac{n N_s V_{th} \log \left(\frac{I_L}{I_0} + 1 \right)}{R_{sh}} \newline
 
-   I = I_L - I_L - \frac{n Ns V_{th} \log \left( \frac{I_L}{I_0} + 1 \right)}{R_{sh}} \newline
+   I = I_L - I_L - \frac{n N_s V_{th} \log \left( \frac{I_L}{I_0} + 1 \right)}{R_{sh}} \newline
 
-   I = - \frac{n Ns V_{th} \log \left( \frac{I_L}{I_0} + 1 \right)}{R_{sh}}
+   I = - \frac{n N_s V_{th} \log \left( \frac{I_L}{I_0} + 1 \right)}{R_{sh}}
 
 References
 ----------
@@ -111,4 +111,4 @@ Clifford W. Hansen, Sandia `Report SAND2015-2065
 
 [4] "Computer simulation of the effects of electrical mismatches in
 photovoltaic cell interconnection circuits" JW Bishop, Solar Cell (1988)
-:doi:`10.1016/0379-6787(88)90059-2`
+:doi:`10.1016/0379-6787(88)90059-2`

docs/sphinx/source/whatsnew.rst

@@ -6,6 +6,7 @@ What's New
 
 These are new features and improvements of note in each release.
 
+.. include:: whatsnew/v0.11.3.rst
 .. include:: whatsnew/v0.11.2.rst
 .. include:: whatsnew/v0.11.1.rst
 .. include:: whatsnew/v0.11.0.rst