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

Author: kandersolar

.github/workflows/asv_check.yml

@@ -16,18 +16,30 @@ jobs:
         shell: bash -el {0}
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           fetch-depth: 0
 
       - name: Install Python
-        uses: actions/setup-python@v3
+        uses: actions/setup-python@v5
         with:
           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
+
       - name: Run asv benchmarks
         run: |
           cd benchmarks

.github/workflows/flake8.yml

@@ -6,9 +6,9 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout source
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Install Python 3.11
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: '3.11'
       - name: Install Flake8 5.0.4 linter
@@ -20,7 +20,7 @@ jobs:
           git remote add upstream https://github.com/pvlib/pvlib-python.git
           git fetch upstream $GITHUB_BASE_REF
       - name: Run Flake8 linter
-        run: git diff upstream/$GITHUB_BASE_REF HEAD | flake8
+        run: git diff upstream/$GITHUB_BASE_REF HEAD -- "*.py" | flake8
           --exclude pvlib/version.py
           --ignore E201,E241,E226,W503,W504
           --max-line-length 79

.github/workflows/joss-pdf.yml

@@ -15,14 +15,14 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     # fetch all commits and tags so versioneer works
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
       with:
         fetch-depth: 0
 
     - name: Set up Python
-      uses: actions/setup-python@v2
+      uses: actions/setup-python@v5
       with:
-        python-version: 3.8
+        python-version: 3.9
 
     - name: Install build tools
       run: |

.github/workflows/publish.yml

@@ -56,28 +56,28 @@ jobs:
     strategy:
       fail-fast: false  # don't cancel other matrix jobs when one fails
       matrix:
-        python-version: [3.7, 3.8, 3.9, "3.10", "3.11"]
+        python-version: [3.9, "3.10", "3.11", "3.12"]
         suffix: ['']  # the alternative to "-min"
         include:
-          - python-version: 3.7
+          - python-version: 3.9
             suffix: -min
 
     runs-on: ubuntu-latest
     if: (github.event_name == 'pull_request_target' && contains(github.event.pull_request.labels.*.name, 'remote-data')) || (github.event_name == 'push')
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         if: github.event_name == 'pull_request_target'
         # pull_request_target runs in the context of the target branch (pvlib/main),
         # but what we need is the hypothetical merge commit from the PR:
         with:
           ref: "refs/pull/${{ github.event.number }}/merge"
 
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
         if: github.event_name == 'push'
 
       - name: Set up conda environment
-        uses: conda-incubator/setup-miniconda@v2
+        uses: conda-incubator/setup-miniconda@v3
         with:
           activate-environment: test_env
           environment-file: ${{ env.REQUIREMENTS }}
@@ -103,9 +103,11 @@ jobs:
         run: pytest pvlib/tests/iotools --cov=./ --cov-report=xml --remote-data
 
       - name: Upload coverage to Codecov
-        if: matrix.python-version == 3.7 && matrix.suffix == ''
-        uses: codecov/codecov-action@v3
+        if: matrix.python-version == 3.9 && matrix.suffix == ''
+        uses: codecov/codecov-action@v4
         with:
           fail_ci_if_error: true
           verbose: true
           flags: remote-data  # flags are configured in codecov.yml
+        env:
+          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

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

@@ -12,12 +12,12 @@ jobs:
       fail-fast: false  # don't cancel other matrix jobs when one fails
       matrix:
         os: [ubuntu-latest, macos-latest, windows-latest]
-        python-version: [3.7, 3.8, 3.9, "3.10", "3.11"]
+        python-version: [3.9, "3.10", "3.11", "3.12"]
         environment-type: [conda, bare]
         suffix: ['']  # placeholder as an alternative to "-min"
         include:
           - os: ubuntu-latest
-            python-version: 3.7
+            python-version: 3.9
             environment-type: conda
             suffix: -min
         exclude:
@@ -31,7 +31,7 @@ jobs:
     steps:
       # We check out only a limited depth and then pull tags to save time
       - name: Checkout source
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           fetch-depth: 100
 
@@ -60,7 +60,7 @@ jobs:
 
       - name: Install bare Python ${{ matrix.python-version }}${{ matrix.suffix }}
         if: matrix.environment-type == 'bare'
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
 
@@ -82,9 +82,11 @@ jobs:
           pytest pvlib --cov=./ --cov-report=xml --ignore=pvlib/tests/iotools
 
       - name: Upload coverage to Codecov
-        if: matrix.python-version == 3.7 && matrix.suffix == '' && matrix.os == 'ubuntu-latest' && matrix.environment-type == 'conda'
-        uses: codecov/codecov-action@v3
+        if: matrix.python-version == 3.9 && matrix.suffix == '' && matrix.os == 'ubuntu-latest' && matrix.environment-type == 'conda'
+        uses: codecov/codecov-action@v4
         with:
           fail_ci_if_error: true
           verbose: true
           flags: core  # flags are configured in codecov.yml
+        env:
+          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

.github/workflows/pytest.yml

@@ -43,6 +43,7 @@ docs/sphinx/source/reference/generated
 docs/sphinx/source/reference/*/generated
 docs/sphinx/source/savefig
 docs/sphinx/source/gallery
+docs/sphinx/source/sg_execution_times.rst
 
 # Installer logs
 pip-log.txt

.gitignore

@@ -7,11 +7,11 @@
     <a href="https://pypi.org/project/pvlib/">
     <img src="https://img.shields.io/pypi/v/pvlib.svg" alt="latest release" />
     </a>
-    <a href="https://anaconda.org/conda-forge/pvlib-python">
-    <img src="https://anaconda.org/conda-forge/pvlib-python/badges/version.svg" />
+    <a href="https://anaconda.org/conda-forge/pvlib">
+    <img src="https://anaconda.org/conda-forge/pvlib/badges/version.svg" />
     </a>
-    <a href="https://anaconda.org/conda-forge/pvlib-python">
-    <img src="https://anaconda.org/conda-forge/pvlib-python/badges/latest_release_date.svg" />
+    <a href="https://anaconda.org/conda-forge/pvlib">
+    <img src="https://anaconda.org/conda-forge/pvlib/badges/latest_release_date.svg" />
     </a>
 </tr>
 <tr>
@@ -50,33 +50,18 @@
     <a href="https://doi.org/10.5281/zenodo.593284">
     <img src="https://zenodo.org/badge/DOI/10.5281/zenodo.593284.svg" alt="zenodo reference">
     </a>
-    <a href="http://joss.theoj.org/papers/41187535cad22dd4b076c89b72f874b1">
-    <img src="http://joss.theoj.org/papers/41187535cad22dd4b076c89b72f874b1/status.svg" alt="JOSS reference" />
-    </a>
-  </td>
-</tr>
-<tr>
-  <td>Downloads</td>
-  <td>
-    <a href="https://pypi.org/project/pvlib/">
-    <img src="https://img.shields.io/pypi/dm/pvlib" alt="PyPI downloads" />
-    </a>
-    <a href="https://anaconda.org/conda-forge/pvlib-python">
-    <img src="https://anaconda.org/conda-forge/pvlib-python/badges/downloads.svg" alt="conda-forge downloads" />
+    <a style="border-width:0" href="https://doi.org/10.21105/joss.05994">
+    <img src="https://joss.theoj.org/papers/10.21105/joss.05994/status.svg" alt="DOI badge" >
     </a>
   </td>
 </tr>
 </table>
 
 
-pvlib python is a community supported tool that provides a set of
+pvlib python is a community developed toolbox that provides a set of
 functions and classes for simulating the performance of photovoltaic
-energy systems. pvlib python was originally ported from the PVLIB MATLAB
-toolbox developed at Sandia National Laboratories and it implements many
-of the models and methods developed at the Labs. More information on
-Sandia Labs PV performance modeling programs can be found at
-https://pvpmc.sandia.gov/. We collaborate with the PVLIB MATLAB project,
-but operate independently of it.
+energy systems and accomplishing related tasks.  The core mission of pvlib python is to provide open,
+reliable, interoperable, and benchmark implementations of PV system models.
 
 
 Documentation
@@ -96,24 +81,39 @@ Contributing
 ============
 
 We need your help to make pvlib-python a great tool!
-Please see the [Contributing page](http://pvlib-python.readthedocs.io/en/stable/contributing.html) for more on how you can contribute.
+Please see the [Contributing page](https://pvlib-python.readthedocs.io/en/stable/contributing/index.html) for more on how you can contribute.
 The long-term success of pvlib-python requires substantial community support.
 
 
 Citing
 ======
 
-If you use pvlib-python in a published work, please cite:
+Many of the contributors to pvlib python work in institutions where
+citation metrics are used in performance or career evaluations. If you
+use pvlib python in a published work, please cite:
+
+**Recommended citation for the pvlib python project**
+
+  Anderson, K., Hansen, C., Holmgren, W., Jensen, A., Mikofski, M., and Driesse, A.
+  "pvlib python: 2023 project update."
+  Journal of Open Source Software, 8(92), 5994, (2023).
+  https://doi.org/10.21105/joss.05994
 
-  William F. Holmgren, Clifford W. Hansen, and Mark A. Mikofski.
+
+**Recommended citation for pvlib iotools**
+
+  Jensen, A., Anderson, K., Holmgren, W., Mikofski, M., Hansen, C., Boeman, L., Loonen, R.
+  "pvlib iotools —- Open-source Python functions for seamless access to solar irradiance data."
+  Solar Energy, 266, 112092, (2023).
+  https://doi.org/10.1016/j.solener.2023.112092
+
+**Historical citation for pvlib python**
+
+  Holmgren, W., Hansen, C., and Mikofski, M.
   "pvlib python: a python package for modeling solar energy systems."
   Journal of Open Source Software, 3(29), 884, (2018).
   https://doi.org/10.21105/joss.00884
 
-Please also cite the DOI corresponding to the specific version of
-pvlib-python that you used. pvlib-python DOIs are listed at
-[Zenodo.org](https://zenodo.org/search?page=1&size=20&q=conceptrecid:593284&all_versions&sort=-version)
-
 If you use pvlib-python in a commercial or publicly-available application, please
 consider displaying one of the "powered by pvlib" logos:
 
@@ -142,6 +142,19 @@ License
 BSD 3-clause.
 
 
+History and acknowledgement
+===========================
+
+pvlib python began in 2013 as a Python translation of the [PVLIB for Matlab](https://github.com/sandialabs/MATLAB_PV_LIB)
+toolbox developed by Sandia National Laboratories. pvlib python has grown substantially since then.
+Today it contains code contributions from over a hundred individuals worldwide
+and is maintained by a core group of PV modelers from a variety of institutions.
+
+pvlib has been supported directly and indirectly by DOE, NumFOCUS, and
+Google Summer of Code funding, university research projects,
+companies that allow their employees to contribute, and from personal time.
+
+
 NumFOCUS
 ========
 

README.md

@@ -113,19 +113,19 @@
     "include": [
         // minimum supported versions
         {
-            "python": "3.7",
+            "python": "3.9",
             "build": "",
-            "numpy": "1.16.5",
-            "pandas": "0.25.0",
-            "scipy": "1.4.0",
+            "numpy": "1.19.5",
+            "pandas": "1.3.0",
+            "scipy": "1.6.0",
             // Note: these don't have a minimum in setup.py
             "h5py": "3.1.0",
-            "ephem": "3.7.6.0",
-            "numba": "0.40.0"
+            "ephem": "4.0.0.1",  // first version to support py 3.9
+            "numba": "0.53.0",  // first version to support py 3.9
         },
         // latest versions available
         {
-            "python": "3.8",
+            "python": "3.9",
             "build": "",
             "numpy": "",
             "pandas": "",

benchmarks/asv.conf.json

@@ -4,7 +4,7 @@
 
 import pandas as pd
 import pvlib
-from pkg_resources import parse_version
+from packaging.version import Version
 
 
 def set_solar_position(obj):
@@ -37,7 +37,7 @@ def time_location_get_clearsky(self):
 class Location_0_6_1:
 
     def setup(self):
-        if parse_version(pvlib.__version__) < parse_version('0.6.1'):
+        if Version(pvlib.__version__) < Version('0.6.1'):
             raise NotImplementedError
 
         set_solar_position(self)