PyOptik 1.9.8.9__tar.gz → 1.9.9__tar.gz

{pyoptik-1.9.8.9 → pyoptik-1.9.9}/.github/workflows/deploy_PyPi.yml

@@ -1,4 +1,4 @@
-name: Deploy Wheel
+name: Deploy Wheel to PyPi
 
 on:
   push:

pyoptik-1.9.9/.github/workflows/deploy_documentation.yml

@@ -0,0 +1,65 @@
+# .github/workflows/deploy_documentation.yml
+name: Documentation
+
+on:
+  push:
+    branches: [ "master" ]
+    tags:
+      - '*'
+  pull_request:
+    branches: [ "master" ]
+
+jobs:
+  documentation:
+    name: Run the documentation building tools
+    runs-on: ubuntu-latest
+    permissions:
+      pull-requests: write
+      contents: write
+
+    steps:
+      - name: "Set-up: Python 3.11"
+        uses: actions/setup-python@v5
+        id: cp311
+        with:
+            python-version: 3.11
+
+      - name: Set up Git user
+        run: |
+          git config --global user.name "GitHub Actions"
+          git config --global user.email "actions@github.com"
+
+      - name: "Install: Dependencies for headless server"
+        shell: bash
+        run: |
+            sudo apt-get update
+            sudo apt-get install -y xvfb jq
+
+      - name: "Checkout requirements and files for testing"
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          submodules: true
+          ref: master
+
+      - name: Install everything, run the tests, produce the .coverage file
+        run: |
+          python -m pip install wheel build
+          python -m build --wheel
+          python -m pip install .[documentation]
+
+      - name: Get current tag
+        id: get_tag
+        run: |
+          git fetch --tags
+          echo "tag=$(git describe --tags --abbrev=0)" >> $GITHUB_ENV
+
+      - name: "Sphinx build"
+        run: |
+          sphinx-build docs/source documentation_build
+
+      - name: "Upload Documentation Artifact"
+        uses: actions/upload-artifact@v4
+        with:
+          name: documentation_build
+          path: documentation_build

pyoptik-1.9.9/.github/workflows/static.yml

@@ -0,0 +1,113 @@
+# Simple workflow for deploying static content to GitHub Pages
+name: Deploy static content to Pages
+
+on:
+  workflow_run:
+    workflows: ["Documentation"]  # This references the name of the first workflow
+    types:
+      - completed  # Run when the Documentation workflow is completed successfully
+
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: write
+  pages: write
+  id-token: write
+
+jobs:
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          ref: documentation_page
+
+      - name: Set up Git user
+        run: |
+          git config --global user.name  "GitHub Actions"
+          git config --global user.email "actions@github.com"
+
+      - name: Download artifact
+        id: download-artifact
+        uses: dawidd6/action-download-artifact@v6
+        with:
+          workflow: deploy_documentation.yml
+          name: documentation_build
+          path: ./documentation_build
+
+      - name: Get current tag
+        id: get_tag
+        run: |
+          # Fetch all tags to ensure we have all relevant history
+          git fetch --tags
+
+          TAG=$(git describe --tags --abbrev=0 || echo "0.0.0.0")
+          echo "tag=$TAG" >> $GITHUB_ENV
+          echo "Tag found or default: $TAG"
+
+      - name: Update new documentation version
+        run: |
+          rm -rf docs/${{ env.tag }}
+          mv documentation_build docs/${{ env.tag }}
+
+      - name: Scan, sort versions, and update version_switcher.json
+        run: |
+          # Define the path to version_switcher.json
+          json_file="version_switcher.json"
+          rm $json_file
+          docs_path="docs"
+          base_url="https://martinpdes.github.io/PyOptik"
+
+          # Start the JSON array
+          echo "[" > $json_file
+
+          # Get sorted version directories in descending order
+          version_dirs=$(ls -v $docs_path | sort -V -r)
+
+
+          # Loop over sorted versions and add to JSON file
+          first_entry=true
+          for version in $version_dirs; do
+            version_url="${base_url}/${docs_path}/${version}"
+
+            # Add a comma if it's not the first entry
+            if [ "$first_entry" = true ]; then
+              first_entry=false
+            else
+              echo "," >> $json_file
+            fi
+
+            # Append each version as a JSON entry
+            jq -n \
+              --arg name "$version" \
+              --arg version "$version" \
+              --arg url "$version_url" \
+              '{name: $name, version: $version, url: $url}' >> $json_file
+          done
+
+          # End the JSON array
+          echo "]" >> $json_file
+
+          # Add and commit the updated version_switcher.json
+          git add $json_file
+          echo $json_file
+          git commit --allow-empty -m "Update version_switcher.json"
+          git push origin HEAD
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: '.'
+
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

{pyoptik-1.9.8.9 → pyoptik-1.9.9}/.gitignore

@@ -1,6 +1,4 @@
-
-
-
+# General patterns
 *.DS_store
 *.ipynb_checkpoints*
 *__pycache__*
@@ -19,7 +17,12 @@ install_manifest.txt
 cmake_install.cmake
 wheelhouse
 
+# Docs-specific patterns
 docs/source/gallery/*
 !docs/source/gallery/index.rst
 PyOptik/data/**/test*
-PyOptik/data/**/example*
+PyOptik/data/**/example*
+
+# Override for documentation_build
+!documentation_build
+!documentation_build/**

{pyoptik-1.9.8.9 → pyoptik-1.9.9}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: PyOptik
-Version: 1.9.8.9
+Version: 1.9.9
 Summary: A package for refractive index values.
 Author-email: Martin Poinsinet de Sivry-Houle <martin.poinsinet.de.sivry@gmail.com>
 License: MIT License
@@ -102,8 +102,9 @@ To install PyOptik, simply use `pip` or `conda`:
 
 .. code:: bash
 
-   pip install PyOptik
-   conda install --channels martinpdes pyoptik
+   pip install PyOptik                               (using PyPi package manager)
+
+   conda install --channels martinpdes pyoptik       (using anaconda environment manager)
 
 Building the Material Library
 *****************************

{pyoptik-1.9.8.9 → pyoptik-1.9.9}/PyOptik/_version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '1.9.8.9'
-__version_tuple__ = version_tuple = (1, 9, 8, 9)
+__version__ = version = '1.9.9'
+__version_tuple__ = version_tuple = (1, 9, 9)

{pyoptik-1.9.8.9 → pyoptik-1.9.9}/PyOptik.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: PyOptik
-Version: 1.9.8.9
+Version: 1.9.9
 Summary: A package for refractive index values.
 Author-email: Martin Poinsinet de Sivry-Houle <martin.poinsinet.de.sivry@gmail.com>
 License: MIT License
@@ -102,8 +102,9 @@ To install PyOptik, simply use `pip` or `conda`:
 
 .. code:: bash
 
-   pip install PyOptik
-   conda install --channels martinpdes pyoptik
+   pip install PyOptik                               (using PyPi package manager)
+
+   conda install --channels martinpdes pyoptik       (using anaconda environment manager)
 
 Building the Material Library
 *****************************

{pyoptik-1.9.8.9 → pyoptik-1.9.9}/PyOptik.egg-info/SOURCES.txt

@@ -6,10 +6,11 @@ README.rst
 meta.yaml
 pyproject.toml
 .github/dependabot.yml
-.github/workflows/create_documentation.yml
 .github/workflows/deploy_PyPi.yml
 .github/workflows/deploy_anaconda.yml
 .github/workflows/deploy_coverage.yml
+.github/workflows/deploy_documentation.yml
+.github/workflows/static.yml
 PyOptik/__init__.py
 PyOptik/__main__.py
 PyOptik/_version.py

{pyoptik-1.9.8.9 → pyoptik-1.9.9}/README.rst

@@ -41,8 +41,9 @@ To install PyOptik, simply use `pip` or `conda`:
 
 .. code:: bash
 
-   pip install PyOptik
-   conda install --channels martinpdes pyoptik
+   pip install PyOptik                               (using PyPi package manager)
+
+   conda install --channels martinpdes pyoptik       (using anaconda environment manager)
 
 Building the Material Library
 *****************************

pyoptik-1.9.8.9/.github/workflows/create_documentation.yml

@@ -1,102 +0,0 @@
-# .github/workflows/deploy_documentation.yml
-name: Documentation
-
-on:
-  push:
-    branches: [ "master" ]
-    tags:
-      - '*'
-  pull_request:
-    branches: [ "master" ]
-
-jobs:
-  documentation:
-    name: Run the documentation building tools
-    runs-on: ubuntu-latest
-    permissions:
-      pull-requests: write
-      contents: write
-
-    steps:
-      - name: "Set-up: Python 3.11"
-        uses: actions/setup-python@v5
-        id: cp311
-        with:
-            python-version: 3.11
-
-      - name: "Install: Dependencies for headless server"
-        shell: bash
-        run: |
-            sudo apt-get update
-            sudo apt-get install -y xvfb jq
-
-      - name: "Checkout requirements and files for testing"
-        uses: actions/checkout@v4
-        with:
-          fetch-depth: 0
-          submodules: true
-
-      - name: Install everything, run the tests, produce the .coverage file
-        run: |
-          python -m pip install wheel build
-          python -m build --wheel
-          python -m pip install .[documentation]
-
-      - name: Get current tag
-        id: get_tag
-        run: |
-          git fetch --tags
-          echo "tag=$(git describe --tags --abbrev=0)" >> $GITHUB_ENV
-
-      - name: Sphinx build
-        run: |
-          sphinx-build docs/source _build
-          git checkout documentation_page
-          git branch documentation_page_temp
-          cd docs
-          git checkout master -- _build
-          mv _build ${{ env.tag }}"
-          cd ..
-
-      - name: Scan, sort versions, and update version_switcher.json
-        run: |
-          # Define the path to version_switcher.json
-          json_file="version_switcher.json"
-          docs_path="docs"
-          base_url="https://martinpdes.github.io/PyOptik"
-
-          # Start the JSON array
-          echo "[" > $json_file
-
-          # Get sorted version directories in descending order
-          version_dirs=$(ls -v $docs_path | sort -V -r)
-
-          # Loop over sorted versions and add to JSON file
-          first_entry=true
-          for version in $version_dirs; do
-            version_url="${base_url}/${docs_path}/${version}"
-
-            # Add a comma if it's not the first entry
-            if [ "$first_entry" = true ]; then
-              first_entry=false
-            else
-              echo "," >> $json_file
-            fi
-
-            # Append each version as a JSON entry
-            jq -n \
-              --arg name "$version" \
-              --arg version "$version" \
-              --arg url "$version_url" \
-              '{name: $name, version: $version, url: $url}' >> $json_file
-          done
-
-          # End the JSON array
-          echo "]" >> $json_file
-
-      - name: Merge to Trigger Pages Build
-        run: |
-          # Merge the changes from documentation_page_temp to documentation_page
-          git checkout documentation_page
-          git merge documentation_page_temp --no-ff
-          git push origin documentation_page