Merge pull request #88 from NREL/development

Automate jupyter-books
NREL · May 6, 2024 · f770097 · f770097
2 parents def3a3f + bb1fa74
commit f770097
Show file tree

Hide file tree

Showing 221 changed files with 49,235 additions and 6,362 deletions.
diff --git a/.github/workflows/deploy-books.yml b/.github/workflows/deploy-books.yml
@@ -0,0 +1,61 @@
+name: deploy-book
+
+# Run this when the master or main branch changes
+on:
+  push:
+    branches:
+    - main
+    # If your git repository has the Jupyter Book within some-subfolder next to
+    # unrelated files, you can make this run only if a file within that specific
+    # folder has been modified.
+    #
+    # paths:
+    # - some-subfolder/**
+
+# This job installs dependencies, builds the book, and pushes it to `gh-pages`
+jobs:
+  deploy-book:
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+    permissions:
+      pages: write
+      id-token: write
+    steps:
+    - uses: actions/checkout@v3
+
+    # Install dependencies
+    - name: Set up Python 3.11
+      uses: actions/setup-python@v4
+      with:
+        python-version: 3.11
+
+    - name: Install dependencies
+      run: |
+        pip install .[books]
+
+    # (optional) Cache your executed notebooks between runs
+    # if you have config:
+    # execute:
+    #   execute_notebooks: cache
+    - name: cache executed notebooks
+      uses: actions/cache@v3
+      with:
+        path: _build/.jupyter_cache
+        key: jupyter-book-cache-${{ hashFiles('requirements.txt') }}
+
+    # Build the book
+    - name: Build the book
+      run: |
+        jupyter-book build tutorials_and_tools
+
+    # Upload the book's HTML as an artifact
+    - name: Upload artifact
+      uses: actions/upload-pages-artifact@v3
+      with:
+        path: "tutorials_and_tools/_build/html"
+
+    # Deploy the book's HTML to GitHub Pages
+    - name: Deploy to GitHub Pages
+      id: deployment
+      uses: actions/deploy-pages@v4
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -8,6 +8,7 @@ repos:
     -   id: end-of-file-fixer
     -   id: check-yaml
     -   id: check-added-large-files
+        args: ["--maxkb=2000"]
 -   repo: https://github.com/psf/black
     rev: 23.11.0
     hooks:

diff --git a/docs/source/whatsnew/index.rst b/docs/source/whatsnew/index.rst
@@ -4,6 +4,7 @@ What's New
 ==========
 PVDegradationTools (pvdeg) change log:
 
+.. include:: releases/v0.3.2.rst
 .. include:: releases/v0.3.1.rst
 .. include:: releases/v0.3.0.rst
 .. include:: releases/v0.2.3.rst

diff --git a/docs/source/whatsnew/releases/v0.3.2.rst b/docs/source/whatsnew/releases/v0.3.2.rst
@@ -0,0 +1,14 @@
+v0.3.1 (2024-05-06)
+=======================
+
+Enhancements
+------------
+* Added workflow for automated deployment of jupyter-books
+
+Bug Fixes
+---------
+* Re-run notebooks and fixed minor bugs
+
+Contributors
+~~~~~~~~~~~~
+* Martin Springer (:ghuser:`martin-springer`)
diff --git a/pvdeg/weather.py b/pvdeg/weather.py
@@ -134,7 +134,7 @@ def read(file_in, file_type, map_variables=True, **kwargs):
         [psm3, tmy3, epw, h5, csv]
     """
 
-    META_MAP = {"elevation": "altitude", "Local Time Zone": "timezone"}
+    META_MAP = {"elevation": "altitude", "Local Time Zone": "tz"}
 
     supported = ["psm3", "tmy3", "epw", "h5", "csv"]
     file_type = file_type.upper()

diff --git a/pyproject.toml b/pyproject.toml
@@ -47,6 +47,7 @@ dependencies = [
     "python-dateutil",
     "pytz",
     "scipy",
+    "seaborn",
     "tables",
     "tqdm",
     "xarray",
@@ -68,8 +69,11 @@ test = [
     "pytest",
     "pytest-cov",
 ]
+books = [
+    "jupyter-book",
+]
 all = [
-    "pvdeg[docs,test]",
+    "pvdeg[docs,test,books]",
 ]
 
 [project.entry-points.pvdeg]

diff --git a/tutorials_and_tools/_build/.doctrees/README.doctree b/tutorials_and_tools/_build/.doctrees/README.doctree
diff --git a/tutorials_and_tools/_build/.doctrees/environment.pickle b/tutorials_and_tools/_build/.doctrees/environment.pickle
diff --git a/tutorials_and_tools/_build/.doctrees/intro.doctree b/tutorials_and_tools/_build/.doctrees/intro.doctree
diff --git a/...rials_and_tools/_build/.doctrees/tutorials_and_tools/1 - Basics, Humidity, Design.doctree b/...rials_and_tools/_build/.doctrees/tutorials_and_tools/1 - Basics, Humidity, Design.doctree
diff --git a/tutorials_and_tools/_build/.doctrees/tutorials_and_tools/2 - Degradation.doctree b/tutorials_and_tools/_build/.doctrees/tutorials_and_tools/2 - Degradation.doctree
diff --git a/tutorials_and_tools/_build/.doctrees/tutorials_and_tools/3 - Spectral Degradation.doctree b/tutorials_and_tools/_build/.doctrees/tutorials_and_tools/3 - Spectral Degradation.doctree
diff --git a/tutorials_and_tools/_build/.doctrees/tutorials_and_tools/4 - Weather Database Access.doctree b/tutorials_and_tools/_build/.doctrees/tutorials_and_tools/4 - Weather Database Access.doctree
diff --git a/tutorials_and_tools/_build/.doctrees/tutorials_and_tools/ASTM Live Demo.doctree b/tutorials_and_tools/_build/.doctrees/tutorials_and_tools/ASTM Live Demo.doctree
diff --git a/tutorials_and_tools/_build/.doctrees/tutorials_and_tools/B-O LID - Accelerated Test.doctree b/tutorials_and_tools/_build/.doctrees/tutorials_and_tools/B-O LID - Accelerated Test.doctree
diff --git a/tutorials_and_tools/_build/.doctrees/tutorials_and_tools/LETID - Accelerated Test.doctree b/tutorials_and_tools/_build/.doctrees/tutorials_and_tools/LETID - Accelerated Test.doctree
diff --git a/tutorials_and_tools/_build/.doctrees/tutorials_and_tools/LETID - Outdoor LETID.doctree b/tutorials_and_tools/_build/.doctrees/tutorials_and_tools/LETID - Outdoor LETID.doctree
diff --git a/...ees/tutorials_and_tools/LETID - Outdoor Scenario Based on Accelerated Test Result.doctree b/...ees/tutorials_and_tools/LETID - Outdoor Scenario Based on Accelerated Test Result.doctree
diff --git a/tutorials_and_tools/_build/.doctrees/tutorials_and_tools/LETID - Passivated Wafer.doctree b/tutorials_and_tools/_build/.doctrees/tutorials_and_tools/LETID - Passivated Wafer.doctree
diff --git a/...ols/_build/.doctrees/tutorials_and_tools/Tools - Module Standoff for IEC TS 63126.doctree b/...ols/_build/.doctrees/tutorials_and_tools/Tools - Module Standoff for IEC TS 63126.doctree
diff --git a/tutorials_and_tools/_build/html/.buildinfo b/tutorials_and_tools/_build/html/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 86a80142bb0890d5262a8dbd1c319561
+config: 99ea9d5a0b679785d9fb1ec934454af7
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/...ml/_images/107f7fef49ab36e6af4427e6bb3ede63b6f2c49cc28e8bed9978b78a2fc25f9d.png b/...ml/_images/107f7fef49ab36e6af4427e6bb3ede63b6f2c49cc28e8bed9978b78a2fc25f9d.png
diff --git a/...ml/_images/14c37892c8b58d28a264bc3509c0dff9bd00e18d854f76e1d1ff0d71676be23e.png b/...ml/_images/14c37892c8b58d28a264bc3509c0dff9bd00e18d854f76e1d1ff0d71676be23e.png
diff --git a/...ml/_images/289ba833c6ff3492e05e012cae1722ae2fe80ee499727ea3af871df5db449f6a.png b/...ml/_images/289ba833c6ff3492e05e012cae1722ae2fe80ee499727ea3af871df5db449f6a.png
diff --git a/...ml/_images/640486cb8d5836d69776fccd5472e808cd03e0b0679c4caa4b2e126fa443a74d.png b/...ml/_images/640486cb8d5836d69776fccd5472e808cd03e0b0679c4caa4b2e126fa443a74d.png
diff --git a/...ml/_images/85d967582ae2bb9bb9a45e1cfc91f4634d41142ea9a3c7811ec4050e970c4b79.png b/...ml/_images/85d967582ae2bb9bb9a45e1cfc91f4634d41142ea9a3c7811ec4050e970c4b79.png
diff --git a/...ml/_images/889fab6bd387f5c1cdbd3697ad508d07ce25e0cdb2e338b73bc4dfe058bf0a73.png b/...ml/_images/889fab6bd387f5c1cdbd3697ad508d07ce25e0cdb2e338b73bc4dfe058bf0a73.png
diff --git a/...ml/_images/8ca345321f03990ea6b8c541d35c9bee777190fd1b6c82a55946243f011a679f.png b/...ml/_images/8ca345321f03990ea6b8c541d35c9bee777190fd1b6c82a55946243f011a679f.png
diff --git a/...ml/_images/a4fc985792ddf3301a6a1d2d827a30e4560482ae6f665332ca5c34c00581af44.png b/...ml/_images/a4fc985792ddf3301a6a1d2d827a30e4560482ae6f665332ca5c34c00581af44.png
diff --git a/...ml/_images/baa77bfc7071cdb8dbe6db743471f2623e8fa6b4caa5fe081a934a0a95e677a5.png b/...ml/_images/baa77bfc7071cdb8dbe6db743471f2623e8fa6b4caa5fe081a934a0a95e677a5.png
diff --git a/...ml/_images/bb1b5e01b51209571f7c16f07967b106d6b7cfedf39d36bf3b1ed247f7603e34.png b/...ml/_images/bb1b5e01b51209571f7c16f07967b106d6b7cfedf39d36bf3b1ed247f7603e34.png
diff --git a/...ml/_images/d1e14a95a0238c112b229d421d9d9cb6dcb41467c123c119e2f9d85ef491d62d.png b/...ml/_images/d1e14a95a0238c112b229d421d9d9cb6dcb41467c123c119e2f9d85ef491d62d.png
diff --git a/...ml/_images/e4247cbd99ddedad38a3ec627def7d83e55865e57f15ac7db963704e8b99f3f8.png b/...ml/_images/e4247cbd99ddedad38a3ec627def7d83e55865e57f15ac7db963704e8b99f3f8.png
diff --git a/tutorials_and_tools/_build/html/_sources/intro.md b/tutorials_and_tools/_build/html/_sources/intro.md
@@ -1,13 +1,13 @@
-# Welcome to the PVDEG Tutorials
+# Welcome to the PVDEG Tutorials and Tools
 
-Here is a collection of Jupyter Journals ready to read, or run in your browser 
-through Google Collab.
-Clicking on the rocket-icon on the top allows you to launch the journals on 
+Here is a collection of Jupyter Journals that include tutorials and tools.
+These are ready to read, install and use, or run in your browser through Google Collab.
+Clicking on the rocket-icon on the top allows you to launch the journals on
 [Google Colaboratory](https://colab.research.google.com/) for interactive mode.
-As per the instructions on each journal, you should uncomment the first line 
+As per the instructions on each journal, you should uncomment the first line
 that reads `pip install ...`  to install the environment if you follow this mode.
 
-You can also clone the repository and run them locally, following the 
+You can also clone the repository and run them locally, following the
 instructions on the [PVDegTools Github page](https://github.com/NREL/PVDegradationTools)
 
 ```{tableofcontents}

diff --git a/tutorials_and_tools/_build/html/_sources/tutorials/1 - Basics, Humidity, Design.ipynb b/tutorials_and_tools/_build/html/_sources/tutorials/1 - Basics, Humidity, Design.ipynb
@@ -29,7 +29,7 @@
    "outputs": [],
    "source": [
     "# if running on google colab, uncomment the next line and execute this cell to install the dependencies and prevent \"ModuleNotFoundError\" in later cells:\n",
-    "# !pip install pvdeg==0.1.1"
+    "# !pip install pvdeg==0.3.2"
    ]
   },
   {

diff --git a/tutorials_and_tools/_build/html/_sources/tutorials/2 - Degradation.ipynb b/tutorials_and_tools/_build/html/_sources/tutorials/2 - Degradation.ipynb
@@ -36,7 +36,7 @@
    "outputs": [],
    "source": [
     "# if running on google colab, uncomment the next line and execute this cell to install the dependencies and prevent \"ModuleNotFoundError\" in later cells:\n",
-    "# !pip install pvdeg==0.1.1"
+    "# !pip install pvdeg==0.3.2"
    ]
   },
   {

diff --git a/tutorials_and_tools/_build/html/_sources/tutorials/3 - Spectral Degradation.ipynb b/tutorials_and_tools/_build/html/_sources/tutorials/3 - Spectral Degradation.ipynb
@@ -30,7 +30,7 @@
    "outputs": [],
    "source": [
     "# if running on google colab, uncomment the next line and execute this cell to install the dependencies and prevent \"ModuleNotFoundError\" in later cells:\n",
-    "# !pip install pvdeg==0.1.1"
+    "# !pip install pvdeg==0.3.2"
    ]
   },
   {

diff --git a/tutorials_and_tools/_build/html/_sources/tutorials/4 - Standards.ipynb b/tutorials_and_tools/_build/html/_sources/tutorials/4 - Standards.ipynb
@@ -37,7 +37,7 @@
    "outputs": [],
    "source": [
     "# if running on google colab, uncomment the next line and execute this cell to install the dependencies and prevent \"ModuleNotFoundError\" in later cells:\n",
-    "# !pip install pvdeg==0.1.1"
+    "# !pip install pvdeg==0.3.2"
    ]
   },
   {

diff --git a/tutorials_and_tools/_build/html/_sources/tutorials/5 - Weather Database Access.ipynb b/tutorials_and_tools/_build/html/_sources/tutorials/5 - Weather Database Access.ipynb
@@ -55,7 +55,7 @@
    "outputs": [],
    "source": [
     "# if running on google colab, uncomment the next line and execute this cell to install the dependencies and prevent \"ModuleNotFoundError\" in later cells:\n",
-    "# !pip install pvdeg==0.1.1"
+    "# !pip install pvdeg==0.3.2"
    ]
   },
   {

diff --git a/tutorials_and_tools/_build/html/_sources/tutorials/B-O LID - Accelerated Test.ipynb b/tutorials_and_tools/_build/html/_sources/tutorials/B-O LID - Accelerated Test.ipynb
@@ -36,7 +36,7 @@
    "outputs": [],
    "source": [
     "# if running on google colab, uncomment the next line and execute this cell to install the dependencies and prevent \"ModuleNotFoundError\" in later cells:\n",
-    "# !pip install pvdeg==0.1.1"
+    "# !pip install pvdeg==0.3.2"
    ]
   },
   {

diff --git a/tutorials_and_tools/_build/html/_sources/tutorials/LETID - Accelerated Test.ipynb b/tutorials_and_tools/_build/html/_sources/tutorials/LETID - Accelerated Test.ipynb
@@ -41,7 +41,7 @@
    "outputs": [],
    "source": [
     "# if running on google colab, uncomment the next line and execute this cell to install the dependencies and prevent \"ModuleNotFoundError\" in later cells:\n",
-    "# !pip install pvdeg==0.1.1"
+    "# !pip install pvdeg==0.3.2"
    ]
   },
   {

diff --git a/tutorials_and_tools/_build/html/_sources/tutorials/LETID - Outdoor LETID.ipynb b/tutorials_and_tools/_build/html/_sources/tutorials/LETID - Outdoor LETID.ipynb
@@ -35,7 +35,7 @@
    "outputs": [],
    "source": [
     "# if running on google colab, uncomment the next line and execute this cell to install the dependencies and prevent \"ModuleNotFoundError\" in later cells:\n",
-    "# !pip install pvdeg==0.1.1"
+    "# !pip install pvdeg==0.3.2"
    ]
   },
   {

diff --git a/...d/html/_sources/tutorials/LETID - Outdoor Scenario Based on Accelerated Test Result.ipynb b/...d/html/_sources/tutorials/LETID - Outdoor Scenario Based on Accelerated Test Result.ipynb
@@ -40,7 +40,7 @@
    "outputs": [],
    "source": [
     "# if running on google colab, uncomment the next line and execute this cell to install the dependencies and prevent \"ModuleNotFoundError\" in later cells:\n",
-    "# !pip install pvdeg==0.1.1"
+    "# !pip install pvdeg==0.3.2"
    ]
   },
   {

diff --git a/tutorials_and_tools/_build/html/_sources/tutorials/LETID - Passivated Wafer.ipynb b/tutorials_and_tools/_build/html/_sources/tutorials/LETID - Passivated Wafer.ipynb
@@ -36,7 +36,7 @@
    "outputs": [],
    "source": [
     "# if running on google colab, uncomment the next line and execute this cell to install the dependencies and prevent \"ModuleNotFoundError\" in later cells:\n",
-    "# !pip install pvdeg==0.1.1"
+    "# !pip install pvdeg==0.3.2"
    ]
   },
   {