Merge pull request #37 from markcampanelli/main

pyproject.toml for builds, using setuptools_scm for versioning
NREL · Jan 30, 2024 · 07d3994 · 07d3994
2 parents 7f12df3 + 236d805
commit 07d3994
Show file tree

Hide file tree

Showing 30 changed files with 350 additions and 2,716 deletions.
diff --git a/.coveragerc b/.coveragerc
diff --git a/.github/workflows/pytest.yml b/.github/workflows/pytest.yml
@@ -16,7 +16,6 @@ jobs:
       matrix:
         python-version: ["3.9", "3.10", "3.11"]
         env: [
-          '-r requirements.txt .[test]',
           '--upgrade --upgrade-strategy=eager .[test]'
         ]
 
@@ -28,8 +27,8 @@ jobs:
         python-version: ${{ matrix.python-version }}
     - name: Install ${{ matrix.env }}
       run: |
-        python -m pip install --upgrade pip wheel
-        pip install ${{ matrix.env }}
+        python -m pip install --progress-bar off --upgrade pip
+        python -m pip install --progress-bar off ${{ matrix.env }}
     - name: Test with pytest ${{ matrix.env }}
       run: |
-        pytest
+        python -m pytest
diff --git a/MANIFEST.in b/MANIFEST.in
@@ -1,5 +1,3 @@
-include versioneer.py
-include pvdeg/_version.py
 include pvdeg/data/*
-include LICENSE
+include *.md
 graft DataLibrary
diff --git a/README.md b/README.md
@@ -50,28 +50,24 @@ It takes a minute to load the environment.
 
 ### Locally
 
-You can also run the tutorial locally with
-[miniconda](https://docs.conda.io/en/latest/miniconda.html) by following thes
-steps:
-
-1. Install [miniconda](https://docs.conda.io/en/latest/miniconda.html).
-
-1. Clone the repository:
+You can also run the tutorial locally in a virtual environment, i.e., `venv` or
+[miniconda](https://docs.conda.io/en/latest/miniconda.html).
 
+1. Create and activate a new environment, e.g., on Mac/Linux terminal with `venv`:
    ```
-   git clone https://github.com/NREL/PVDegradationTools.git
+   python -m venv pvdeg
+   . pvdeg/bin/activate
    ```
-
-1. Create the environment and install the requirements. The repository includes
-   a `requirements.txt` file that contains a list the packages needed to run
-   this tutorial. To install them using conda run:
-
+   or with `conda`:
    ```
-   conda create -n pvdeg jupyter -c pvlib --file requirements.txt
+   conda create -n pvdeg
    conda activate pvdeg
    ```
 
-   or you can install it with `pip install pvdeg` as explained in the installation instructions into the environment.
+1. Install `pvdeg` into the new environment with `pip`:
+   ```
+   python -m pip install pvdeg
+   ```
 
 1. Start a Jupyter session:
 
@@ -98,9 +94,9 @@ Install with:
 
     pip install pvdeg
 
-For developer installation, download the repository, navigate to the folder location and install as:
+For developer installation, clone the repository, navigate to the folder location and install as:
 
-    pip install -e .
+    pip install -e .[all]
 
 
 License

diff --git a/contributors/markcampanelli.md b/contributors/markcampanelli.md
@@ -0,0 +1,11 @@
+2024-01-09
+
+I hereby agree to the terms of the Contributors License Agreement,
+version 1.0, with MD5 checksum 46ea45f996295bdb0652333d516a6d0a.
+
+I furthermore declare that I am authorized and able to make this
+agreement and sign this declaration.
+
+Signed,
+
+Mark Campanelli https://github.com/markcampanelli
diff --git a/docs/sphinx/source/_autosummary/pvdeg.collection.rst b/docs/sphinx/source/_autosummary/pvdeg.collection.rst
@@ -3,17 +3,30 @@
 
 .. automodule:: pvdeg.collection
 
+
+
+
 
-
-
-
-
-
+
+
    .. rubric:: Functions
 
    .. autosummary::
-
+   
       calculate_jsc_from_tau_cp
       calculate_jsc_from_tau_iqe
       collection_probability
       generation_current
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/sphinx/source/_autosummary/pvdeg.degradation.rst b/docs/sphinx/source/_autosummary/pvdeg.degradation.rst
@@ -3,18 +3,31 @@
 
 .. automodule:: pvdeg.degradation
 
+
+
+
 
-
-
-
-
-
+
+
    .. rubric:: Functions
 
    .. autosummary::
-
+   
       IwaArrhenius
       IwaVantHoff
       arrhenius_deg
       degradation
       vantHoff_deg
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/sphinx/source/_autosummary/pvdeg.design.rst b/docs/sphinx/source/_autosummary/pvdeg.design.rst
@@ -3,15 +3,28 @@
 
 .. automodule:: pvdeg.design
 
+
+
+
 
+
+
+   .. rubric:: Functions
 
+   .. autosummary::
+
+      edge_seal_ingress_rate
+      edge_seal_width
+
+
 
+
+
+
 
+
+
+
 
 
-   .. rubric:: Functions
 
-   .. autosummary::
-
-      edge_seal_ingress_rate
-      edge_seal_width
diff --git a/docs/sphinx/source/_autosummary/pvdeg.fatigue.rst b/docs/sphinx/source/_autosummary/pvdeg.fatigue.rst
@@ -3,14 +3,27 @@
 
 .. automodule:: pvdeg.fatigue
 
+
+
+
 
+
+
+   .. rubric:: Functions
 
+   .. autosummary::
+
+      solder_fatigue
+
+
 
+
+
+
 
+
+
+
 
 
-   .. rubric:: Functions
 
-   .. autosummary::
-
-      solder_fatigue
diff --git a/docs/sphinx/source/_autosummary/pvdeg.humidity.rst b/docs/sphinx/source/_autosummary/pvdeg.humidity.rst
@@ -3,16 +3,16 @@
 
 .. automodule:: pvdeg.humidity
 
+
+
+
 
-
-
-
-
-
+
+
    .. rubric:: Functions
 
    .. autosummary::
-
+   
       Ce_numba
       back_encap
       backsheet
@@ -21,5 +21,17 @@
       front_encap
       module
       psat
-      run_module
       surface_outside
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/sphinx/source/_autosummary/pvdeg.letid.rst b/docs/sphinx/source/_autosummary/pvdeg.letid.rst
@@ -3,16 +3,16 @@
 
 .. automodule:: pvdeg.letid
 
+
+
+
 
-
-
-
-
-
+
+
    .. rubric:: Functions
 
    .. autosummary::
-
+   
       calc_device_params
       calc_dn
       calc_energy_loss
@@ -30,3 +30,16 @@
       j0_gray
       k_ij
       tau_now
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/sphinx/source/_autosummary/pvdeg.spectral.rst b/docs/sphinx/source/_autosummary/pvdeg.spectral.rst
@@ -3,15 +3,28 @@
 
 .. automodule:: pvdeg.spectral
 
+
+
+
 
+
+
+   .. rubric:: Functions
 
+   .. autosummary::
+
+      poa_irradiance
+      solar_position
+
+
 
+
+
+
 
+
+
+
 
 
-   .. rubric:: Functions
 
-   .. autosummary::
-
-      poa_irradiance
-      solar_position
diff --git a/docs/sphinx/source/_autosummary/pvdeg.standards.rst b/docs/sphinx/source/_autosummary/pvdeg.standards.rst
@@ -3,16 +3,28 @@
 
 .. automodule:: pvdeg.standards
 
+
+
+
 
+
+
+   .. rubric:: Functions
 
+   .. autosummary::
+
+      eff_gap
+      standoff
+
+
 
+
+
+
 
+
+
+
 
 
-   .. rubric:: Functions
 
-   .. autosummary::
-
-      calc_standoff
-      eff_gap
-      run_calc_standoff