Merge remote-tracking branch 'upstream/main' into freq_M_to_ME

Author: AdamRJensen

.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` ``).

.github/workflows/asv_check.yml

@@ -26,19 +26,7 @@ jobs:
           python-version: '3.9'
 
       - name: Install asv
-        run: pip install asv==0.4.2
-
-      # asv 0.4.2 (and more recent versions as well) creates conda envs
-      # using the --force option, which was removed in conda 24.3.
-      # Since ubuntu-latest now comes with conda 24.3 pre-installed,
-      # using the system's conda will result in error.
-      # To prevent that, we install an older version.
-      # TODO: remove this when we eventually upgrade our asv version.
-      # https://github.com/airspeed-velocity/asv/issues/1396
-      - name: Install Conda
-        uses: conda-incubator/setup-miniconda@v3
-        with:
-          conda-version: 24.1.2
+        run: pip install asv==0.6.4
 
       - name: Run asv benchmarks
         run: |

.github/workflows/publish.yml

@@ -33,9 +33,21 @@ jobs:
     - name: Build packages
       run: python -m build
 
+    - name: List distribution file sizes
+      run: du -h dist/*
+
     - name: Check metadata verification
       run: python -m twine check --strict dist/*
 
+    - name: Ensure that the wheel installs successfully
+      run: |
+        mkdir ./tmp
+        pip install $(find dist -type f -name "*.whl") --target=./tmp
+
+    - name: List installed file sizes
+      run: du -h pvlib
+      working-directory: ./tmp
+
     # only publish distribution to PyPI for tagged commits
     - name: Publish distribution to PyPI
       if: startsWith(github.ref, 'refs/tags/v')

.github/workflows/pytest-remote-data.yml

@@ -56,7 +56,7 @@ jobs:
     strategy:
       fail-fast: false  # don't cancel other matrix jobs when one fails
       matrix:
-        python-version: [3.9, "3.10", "3.11", "3.12"]
+        python-version: [3.9, "3.10", "3.11", "3.12", "3.13"]
         suffix: ['']  # the alternative to "-min"
         include:
           - python-version: 3.9
@@ -100,7 +100,7 @@ jobs:
           SOLARANYWHERE_API_KEY: ${{ secrets.SOLARANYWHERE_API_KEY }}
           BSRN_FTP_USERNAME: ${{ secrets.BSRN_FTP_USERNAME }}
           BSRN_FTP_PASSWORD: ${{ secrets.BSRN_FTP_PASSWORD }}
-        run: pytest pvlib/tests/iotools --cov=./ --cov-report=xml --remote-data
+        run: pytest tests/iotools --cov=./ --cov-report=xml --remote-data
 
       - name: Upload coverage to Codecov
         if: matrix.python-version == 3.9 && matrix.suffix == ''

.github/workflows/pytest.yml

@@ -12,7 +12,7 @@ jobs:
       fail-fast: false  # don't cancel other matrix jobs when one fails
       matrix:
         os: [ubuntu-latest, macos-latest, windows-latest]
-        python-version: [3.9, "3.10", "3.11", "3.12"]
+        python-version: [3.9, "3.10", "3.11", "3.12", "3.13"]
         environment-type: [conda, bare]
         suffix: ['']  # placeholder as an alternative to "-min"
         include:
@@ -79,7 +79,7 @@ jobs:
         shell: bash -l {0}  # necessary for conda env to be active
         run: |
           # ignore iotools; those tests are run in a separate workflow
-          pytest pvlib --cov=./ --cov-report=xml --ignore=pvlib/tests/iotools
+          pytest tests --cov=./ --cov-report=xml --ignore=tests/iotools
 
       - name: Upload coverage to Codecov
         if: matrix.python-version == 3.9 && matrix.suffix == '' && matrix.os == 'ubuntu-latest' && matrix.environment-type == 'conda'

.github/workflows/top-ranked-issues.yml

@@ -0,0 +1,34 @@
+name: Update Top Ranked Issues
+
+on:
+  schedule:
+    # Runs every day at 00:00 AM UTC
+    - cron: '0 0 * * *'
+
+jobs:
+  run-script:
+    runs-on: ubuntu-latest
+
+    # Run only if the repository is pvlib/pvlib-python
+    if: ${{ github.repository == 'pvlib/pvlib-python' }}
+
+    env:
+      GITHUB_ACCESS_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+    steps:
+      - name: Check out the repository
+        uses: actions/checkout@v4  # This ensures the repository code is available
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install PyGithub
+
+      - name: Run update_top_ranking_issues.py
+        run: |
+          python ./scripts/update_top_ranking_issues.py

.gitignore

@@ -81,9 +81,9 @@ coverage.xml
 
 
 # Datafiles
-*.csv
-# Ignore some csv 
-!pvlib/data/*.csv 
+# Do not exclude data directories
+!pvlib/data/**
+!tests/data/**
 
 # vi
 *.swp

ci/requirements-py3.12.yml

@@ -25,4 +25,4 @@ dependencies:
     - statsmodels
     - pip:
         - nrel-pysam>=2.0
-        # - solarfactors  # required shapely<2 isn't available for 3.12
+        - solarfactors

ci/requirements-py3.13.yml

@@ -0,0 +1,28 @@
+name: test_env
+channels:
+    - defaults
+    - conda-forge
+dependencies:
+    - coveralls
+    - cython
+    - ephem
+    - h5py
+    - numba
+    - numpy >= 1.17.3
+    - pandas >= 1.3.0
+    - pip
+    - pytest
+    - pytest-cov
+    - pytest-mock
+    - requests-mock
+    - pytest-timeout
+    - pytest-rerunfailures
+    - conda-forge::pytest-remotedata  # version in default channel is old
+    - python=3.13
+    - pytz
+    - requests
+    - scipy >= 1.6.0
+    - statsmodels
+    - pip:
+        - nrel-pysam>=2.0
+        - solarfactors

codecov.yml

@@ -14,14 +14,15 @@ flags:
   core:
     paths:
       - pvlib/
+      - tests/
       - '!pvlib/iotools/'
-      - '!pvlib/tests/iotools/'
+      - '!tests/iotools/'
     carryforward: false
 
   remote-data:
     paths:
       - pvlib/iotools/
-      - pvlib/tests/iotools
+      - tests/iotools
     carryforward: true  # if not run, use coverage from previous commit
 
 
@@ -47,15 +48,15 @@ coverage:
       tests-core:
         target: 95%
         paths:
-          - 'pvlib/tests/.*'
-          - '!pvlib/tests/iotools/.*'
+          - 'tests/.*'
+          - '!tests/iotools/.*'
         flags:
           - core
 
       tests-remote-data:
         target: 95%
         paths:
-          - 'pvlib/tests/iotools/.*'
+          - 'tests/iotools/.*'
         flags:
           - remote-data
 

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/_images/example_function_screenshot.png

@@ -0,0 +1,10 @@
+/* Overrides for sphinx-hoverxref since it does not support a native dark theme, see */
+/* https://github.com/readthedocs/sphinx-hoverxref/issues/231 */
+/* Inspired by https://github.com/pybamm-team/PyBaMM/pull/3083 */
+
+/* These will ensure that the tooltip inherits the pydata-sphinx-theme colours */
+
+.tooltipster-sidetip.tooltipster-shadow.tooltipster-shadow-custom .tooltipster-content {
+    background-color: var(--pst-color-background) !important;
+    color: var(--pst-color-text-base) !important;
+}

docs/sphinx/source/_static/tooltipster_color_theming.css

@@ -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.
@@ -263,6 +282,8 @@ def setup(app):
     app.add_css_file("reference_format.css")
     # Add a warning banner at the top of the page if viewing the "latest" docs
     app.add_js_file("version-alert.js")
+    # Match the color theme of tooltips to PyData Sphinx Theme light/dark mode
+    app.add_css_file("tooltipster_color_theming.css")
 
 # -- Options for LaTeX output ---------------------------------------------
 
@@ -357,15 +378,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/conf.py

@@ -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/how_to_contribute_new_code.rst

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