PyOptik 3.2.0__tar.gz → 3.2.1__tar.gz

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

@@ -0,0 +1,56 @@
+# Simple workflow for deploying static content to GitHub Pages
+name: Documentation
+
+on:
+  push:
+    branches: [ "master" ]
+    tags: [ "v*" ]
+  pull_request:
+    branches: [ "master" ]
+
+concurrency:
+  group: documentation-build-${{ github.repository }}-${{ github.ref }}
+  cancel-in-progress: true
+
+permissions:
+  contents: write
+  pages: write
+  id-token: write
+
+jobs:
+  ManyLinux_x86_64:
+    uses: MartinPdeS/MPSActions/.github/workflows/publish_documentation.yml@v5
+    with:
+      python-version: "3.11"
+      package-name: "PyOptik"
+      apt-package: xvfb jq
+      deploy-pages: ${{ github.event_name == 'push' && (github.ref == 'refs/heads/master' || startsWith(github.ref, 'refs/tags/v')) }}
+
+  deploy_pages:
+    needs: ManyLinux_x86_64
+    if: ${{ github.event_name == 'push' && (github.ref == 'refs/heads/master' || startsWith(github.ref, 'refs/tags/v')) }}
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      pages: write
+      id-token: write
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Checkout generated documentation
+        uses: actions/checkout@fbc6f3992d24b796d5a048ff273f7fcc4a7b6c09
+        with:
+          ref: documentation_page
+
+      - name: Configure GitHub Pages
+        uses: actions/configure-pages@v5
+
+      - name: Upload GitHub Pages artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: .
+
+      - name: Deploy GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

{pyoptik-3.2.0 → pyoptik-3.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PyOptik
-Version: 3.2.0
+Version: 3.2.1
 Summary: A package for refractive index values.
 Author-email: Martin Poinsinet de Sivry-Houle <martin.poinsinet.de.sivry@gmail.com>
 License: MIT License

{pyoptik-3.2.0 → pyoptik-3.2.1}/PyOptik/_version.py

@@ -18,7 +18,7 @@ version_tuple: tuple[int | str, ...]
 commit_id: str | None
 __commit_id__: str | None
 
-__version__ = version = '3.2.0'
-__version_tuple__ = version_tuple = (3, 2, 0)
+__version__ = version = '3.2.1'
+__version_tuple__ = version_tuple = (3, 2, 1)
 
-__commit_id__ = commit_id = 'g7c8410160'
+__commit_id__ = commit_id = 'g6f0650682'

{pyoptik-3.2.0 → pyoptik-3.2.1}/PyOptik/catalog.py

@@ -1,6 +1,5 @@
 """Catalog and upstream-identity support for optical material data."""
 
-from __future__ import annotations
 
 from dataclasses import dataclass
 from pathlib import Path
@@ -78,7 +77,7 @@ class MaterialPage:
         if not self.available:
             return None
         try:
-            with self.local_path.open("r") as stream:
+            with self.local_path.open("r", encoding="utf-8") as stream:
                 reference = (yaml.safe_load(stream) or {}).get("REFERENCES")
                 return str(reference) if reference is not None else None
         except (OSError, yaml.YAMLError):
@@ -286,7 +285,7 @@ class MaterialCatalog:
         existing_manifest = None
         if catalog_file.exists() and not force:
             try:
-                with (root / "manifest.json").open("r") as stream:
+                with (root / "manifest.json").open("r", encoding="utf-8") as stream:
                     existing_manifest = json.load(stream)
             except (FileNotFoundError, json.JSONDecodeError):
                 existing_manifest = None
@@ -381,7 +380,7 @@ class MaterialCatalog:
     def load_catalog(self, catalog_file: Path | str) -> None:
         """Load an upstream ``catalog-nk.yml`` file."""
         catalog_file = Path(catalog_file)
-        with catalog_file.open("r") as stream:
+        with catalog_file.open("r", encoding="utf-8") as stream:
             document = yaml.safe_load(stream) or []
         self._pages.clear()
 
@@ -529,7 +528,7 @@ class MaterialCatalog:
         if not self.manifest_path.exists():
             return {"catalog": {}, "pages": {}}
         try:
-            with self.manifest_path.open("r") as stream:
+            with self.manifest_path.open("r", encoding="utf-8") as stream:
                 manifest = json.load(stream)
             manifest.setdefault("catalog", {})
             manifest.setdefault("pages", {})
@@ -542,7 +541,7 @@ class MaterialCatalog:
         """Atomically write the download manifest after a page completes."""
         self.data_root.mkdir(parents=True, exist_ok=True)
         temporary = self.manifest_path.with_suffix(".json.tmp")
-        with temporary.open("w") as stream:
+        with temporary.open("w", encoding="utf-8") as stream:
             json.dump(manifest, stream, indent=2, sort_keys=True)
             stream.write("\n")
         temporary.replace(self.manifest_path)

{pyoptik-3.2.0 → pyoptik-3.2.1}/PyOptik/material/dataset.py

@@ -1,6 +1,5 @@
 """Typed, validated representations of PyOptik material datasets."""
 
-from __future__ import annotations
 
 from dataclasses import dataclass, field
 from pathlib import Path

{pyoptik-3.2.0 → pyoptik-3.2.1}/PyOptik/thin_film.py

@@ -1,6 +1,5 @@
 """Fresnel interfaces and coherent thin-film transfer-matrix calculations."""
 
-from __future__ import annotations
 
 from dataclasses import dataclass
 from typing import Any, Iterable

{pyoptik-3.2.0 → pyoptik-3.2.1}/PyOptik/tui.py

@@ -1,6 +1,5 @@
 """Optional Textual terminal interface for browsing the material catalog."""
 
-from __future__ import annotations
 
 from pathlib import Path
 

{pyoptik-3.2.0 → pyoptik-3.2.1}/PyOptik.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PyOptik
-Version: 3.2.0
+Version: 3.2.1
 Summary: A package for refractive index values.
 Author-email: Martin Poinsinet de Sivry-Houle <martin.poinsinet.de.sivry@gmail.com>
 License: MIT License

{pyoptik-3.2.0 → pyoptik-3.2.1}/PyOptik.egg-info/SOURCES.txt

@@ -76,8 +76,11 @@ docs/source/materials_and_catalog.rst
 docs/source/references.rst
 docs/source/sg_execution_times.rst
 docs/source/thin_films.rst
+docs/source/user_guide.rst
 docs/source/_static/default.css
 docs/source/_static/favicon.png
+docs/source/_static/favicon.svg
+docs/source/_static/logo-dark.svg
 docs/source/_static/logo.svg
 docs/source/_static/thumbnail.png
 tests/__init__.py

{pyoptik-3.2.0 → pyoptik-3.2.1}/PyOptik.egg-info/scm_file_list.json

@@ -58,6 +58,8 @@
     "docs/make.bat",
     "docs/source/_static/default.css",
     "docs/source/_static/favicon.png",
+    "docs/source/_static/favicon.svg",
+    "docs/source/_static/logo-dark.svg",
     "docs/source/_static/logo.svg",
     "docs/source/_static/thumbnail.png",
     "docs/source/catalog_browser.rst",
@@ -72,6 +74,7 @@
     "docs/source/references.rst",
     "docs/source/sg_execution_times.rst",
     "docs/source/thin_films.rst",
+    "docs/source/user_guide.rst",
     "pyproject.toml",
     "pytest.ini",
     "tests/__init__.py",

pyoptik-3.2.1/PyOptik.egg-info/scm_version.json

@@ -0,0 +1,8 @@
+{
+  "tag": "3.2.1",
+  "distance": 0,
+  "node": "g6f0650682bb62d97e4d26a7dad770bdd207d0f42",
+  "dirty": true,
+  "branch": "HEAD",
+  "node_date": "2026-09-21"
+}

pyoptik-3.2.1/docs/images/logo.svg

@@ -0,0 +1,22 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 920 240" role="img" aria-labelledby="title description">
+  <title id="title">PyOptik</title>
+  <desc id="description">A beam of light passing through a prism and separating into three colors.</desc>
+  <defs>
+    <linearGradient id="prism" x1="0" y1="0" x2="1" y2="1">
+      <stop offset="0" stop-color="#1d73be"/>
+      <stop offset="1" stop-color="#0b2c4d"/>
+    </linearGradient>
+  </defs>
+  <g fill="none" stroke-linecap="round" stroke-linejoin="round">
+    <path d="M122 20 222 210H22Z" fill="url(#prism)" stroke="#45c2e6" stroke-width="6"/>
+    <path d="M0 133 105 116" stroke="#0e7490" stroke-width="10"/>
+    <path d="M105 116 146 111" stroke="#eaf8ff" stroke-width="10"/>
+    <path d="M146 111 250 65" stroke="#40c7ee" stroke-width="9"/>
+    <path d="M146 111 258 111" stroke="#32c69a" stroke-width="9"/>
+    <path d="M146 111 250 157" stroke="#f2b84b" stroke-width="9"/>
+  </g>
+  <g font-family="Inter, Avenir Next, Segoe UI, Arial, sans-serif">
+    <text x="290" y="126" fill="#102f52" font-size="92" font-weight="700" letter-spacing="-3">PyOptik</text>
+    <text x="296" y="174" fill="#39759e" font-size="24" font-weight="650" letter-spacing="5">OPTICAL MATERIALS</text>
+  </g>
+</svg>

{pyoptik-3.2.0 → pyoptik-3.2.1}/docs/source/_static/default.css

@@ -16,4 +16,21 @@ div.highlight a {
 /* Stack components in footer vertically. */
 .bd-footer .footer-items__end, .bd-footer .footer-items__start {
   flex-direction: row;
-}
+}
+
+/* Give the responsive wordmark a predictable footprint in the header. */
+.navbar-brand.logo img {
+  width: 12.5rem;
+  max-height: 3.25rem;
+}
+
+/* Keep the compact primary navigation on one line at desktop widths. */
+@media (min-width: 960px) {
+  .bd-header .navbar-nav {
+    flex-wrap: nowrap;
+  }
+
+  .bd-header .nav-link {
+    white-space: nowrap;
+  }
+}

pyoptik-3.2.1/docs/source/_static/favicon.svg

@@ -0,0 +1,18 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 240 240" role="img" aria-labelledby="title">
+  <title id="title">PyOptik prism</title>
+  <defs>
+    <linearGradient id="prism" x1="0" y1="0" x2="1" y2="1">
+      <stop offset="0" stop-color="#278bd5"/>
+      <stop offset="1" stop-color="#0b2c4d"/>
+    </linearGradient>
+  </defs>
+  <rect width="240" height="240" rx="42" fill="#101923"/>
+  <g fill="none" stroke-linecap="round" stroke-linejoin="round">
+    <path d="M108 28 181 190H35Z" fill="url(#prism)" stroke="#62d5f2" stroke-width="6"/>
+    <path d="M8 125 94 110" stroke="#eaf8ff" stroke-width="10"/>
+    <path d="M94 110 125 106" stroke="#ffffff" stroke-width="10"/>
+    <path d="M125 106 224 70" stroke="#50d7f6" stroke-width="9"/>
+    <path d="M125 106 230 111" stroke="#48d8aa" stroke-width="9"/>
+    <path d="M125 106 221 151" stroke="#ffc95c" stroke-width="9"/>
+  </g>
+</svg>

pyoptik-3.2.1/docs/source/_static/logo-dark.svg

@@ -0,0 +1,22 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 920 240" role="img" aria-labelledby="title description">
+  <title id="title">PyOptik</title>
+  <desc id="description">A beam of light passing through a prism and separating into three colors.</desc>
+  <defs>
+    <linearGradient id="prism" x1="0" y1="0" x2="1" y2="1">
+      <stop offset="0" stop-color="#278bd5"/>
+      <stop offset="1" stop-color="#12395f"/>
+    </linearGradient>
+  </defs>
+  <g fill="none" stroke-linecap="round" stroke-linejoin="round">
+    <path d="M122 20 222 210H22Z" fill="url(#prism)" stroke="#62d5f2" stroke-width="6"/>
+    <path d="M0 133 105 116" stroke="#d9f5ff" stroke-width="10"/>
+    <path d="M105 116 146 111" stroke="#ffffff" stroke-width="10"/>
+    <path d="M146 111 250 65" stroke="#50d7f6" stroke-width="9"/>
+    <path d="M146 111 258 111" stroke="#48d8aa" stroke-width="9"/>
+    <path d="M146 111 250 157" stroke="#ffc95c" stroke-width="9"/>
+  </g>
+  <g font-family="Inter, Avenir Next, Segoe UI, Arial, sans-serif">
+    <text x="290" y="126" fill="#f3f8fc" font-size="92" font-weight="700" letter-spacing="-3">PyOptik</text>
+    <text x="296" y="174" fill="#9cc9e5" font-size="24" font-weight="650" letter-spacing="5">OPTICAL MATERIALS</text>
+  </g>
+</svg>

pyoptik-3.2.1/docs/source/_static/logo.svg

@@ -0,0 +1,22 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 920 240" role="img" aria-labelledby="title description">
+  <title id="title">PyOptik</title>
+  <desc id="description">A beam of light passing through a prism and separating into three colors.</desc>
+  <defs>
+    <linearGradient id="prism" x1="0" y1="0" x2="1" y2="1">
+      <stop offset="0" stop-color="#1d73be"/>
+      <stop offset="1" stop-color="#0b2c4d"/>
+    </linearGradient>
+  </defs>
+  <g fill="none" stroke-linecap="round" stroke-linejoin="round">
+    <path d="M122 20 222 210H22Z" fill="url(#prism)" stroke="#45c2e6" stroke-width="6"/>
+    <path d="M0 133 105 116" stroke="#0e7490" stroke-width="10"/>
+    <path d="M105 116 146 111" stroke="#eaf8ff" stroke-width="10"/>
+    <path d="M146 111 250 65" stroke="#40c7ee" stroke-width="9"/>
+    <path d="M146 111 258 111" stroke="#32c69a" stroke-width="9"/>
+    <path d="M146 111 250 157" stroke="#f2b84b" stroke-width="9"/>
+  </g>
+  <g font-family="Inter, Avenir Next, Segoe UI, Arial, sans-serif">
+    <text x="290" y="126" fill="#102f52" font-size="92" font-weight="700" letter-spacing="-3">PyOptik</text>
+    <text x="296" y="174" fill="#39759e" font-size="24" font-weight="650" letter-spacing="5">OPTICAL MATERIALS</text>
+  </g>
+</svg>

{pyoptik-3.2.0 → pyoptik-3.2.1}/docs/source/conf.py

@@ -46,7 +46,7 @@ napoleon_google_docstring = False
 napoleon_numpy_docstring = True
 
 html_logo = "_static/logo.svg"
-html_favicon = "_static/favicon.png"
+html_favicon = "_static/favicon.svg"
 
 
 examples_files = [
@@ -106,7 +106,11 @@ binder_branch = f"v{major}.{minor}.x"
 
 html_theme_options = dict()
 
-html_theme_options['logo'] = dict(text=package_name, image="_static/logo.svg")
+html_theme_options['logo'] = dict(
+    text="",
+    image_light="_static/logo.svg",
+    image_dark="_static/logo-dark.svg",
+)
 html_theme_options["show_nav_level"] = 0
 
 html_theme_options.update({

{pyoptik-3.2.0 → pyoptik-3.2.1}/docs/source/index.rst

@@ -41,30 +41,10 @@ Quick example
    print(interface.reflectance)
 
 .. toctree::
-   :caption: Start here
    :maxdepth: 2
 
    getting_started
-
-.. toctree::
-   :caption: User guide
-   :maxdepth: 2
-
-   materials_and_catalog
-   custom_materials
-   thin_films
-   catalog_browser
-
-.. toctree::
-   :caption: Learn by example
-   :maxdepth: 2
-
+   user_guide
    examples
-
-.. toctree::
-   :caption: Reference
-   :maxdepth: 2
-
-   conventions
    code
    references

pyoptik-3.2.1/docs/source/user_guide.rst

@@ -0,0 +1,35 @@
+User guide
+==========
+
+Use these guides to move from material discovery to complete optical
+calculations.
+
+.. list-table::
+   :widths: 28 72
+
+   * - :doc:`Materials and catalog <materials_and_catalog>`
+     - Choose a material model, search the RefractiveIndex.INFO catalog, and
+       preserve provenance.
+   * - :doc:`Custom materials <custom_materials>`
+     - Import arrays or CSV data, define formula coefficients, validate data,
+       and export YAML.
+   * - :doc:`Interfaces and thin films <thin_films>`
+     - Calculate Fresnel coefficients, characteristic angles, and coherent
+       multilayer spectra.
+   * - :doc:`Catalog browser <catalog_browser>`
+     - Search and inspect the downloaded database from an interactive terminal
+       interface.
+   * - :doc:`Physical conventions <conventions>`
+     - Review wavelength, sign, interpolation, power, and provenance
+       conventions.
+
+.. toctree::
+   :hidden:
+   :maxdepth: 2
+
+   materials_and_catalog
+   custom_materials
+   thin_films
+   catalog_browser
+   conventions
+

{pyoptik-3.2.0 → pyoptik-3.2.1}/tests/test_catalog.py

@@ -1,5 +1,6 @@
 import io
 import zipfile
+from pathlib import Path
 
 import yaml
 
@@ -39,6 +40,31 @@ def test_catalog_reads_upstream_hierarchy(tmp_path):
     assert matches[0].provenance()["available"] is False
 
 
+def test_catalog_opens_unicode_yaml_as_utf8(tmp_path, monkeypatch):
+    catalog_file = tmp_path / "catalog-nk.yml"
+    catalog_file.write_text(
+        "- SHELF: main\n"
+        "  content:\n"
+        "  - BOOK: Au\n"
+        "    content:\n"
+        "    - PAGE: Test\n"
+        "      name: Gold – thin film\n"
+        "      data: main/Au/nk/Test.yml\n",
+        encoding="utf-8",
+    )
+    original_open = Path.open
+
+    def checked_open(path, *args, **kwargs):
+        if path == catalog_file:
+            assert kwargs.get("encoding") == "utf-8"
+        return original_open(path, *args, **kwargs)
+
+    monkeypatch.setattr(Path, "open", checked_open)
+
+    catalog = MaterialCatalog(catalog_file=catalog_file, data_root=tmp_path / "rii")
+    assert catalog.get("main/Au/Test").description == "Gold – thin film"
+
+
 def test_catalog_loads_local_page(tmp_path):
     data_root = tmp_path / "rii"
     data_file = data_root / "main/Si/nk/Test.yml"

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

@@ -1,23 +0,0 @@
-# Simple workflow for deploying static content to GitHub Pages
-name: Documentation
-
-on:
-  push:
-    branches: [ "master" ]
-    tags: '*'
-  pull_request:
-    branches: [ "master" ]
-
-# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
-permissions:
-  contents: write
-  pages: write
-  id-token: write
-
-jobs:
-  ManyLinux_x86_64:
-    uses: MartinPdeS/MPSActions/.github/workflows/publish_documentation.yml@v5
-    with:
-      python-version: "3.11"
-      package-name: "PyOptik"
-      apt-package: xvfb jq

pyoptik-3.2.0/PyOptik.egg-info/scm_version.json

@@ -1,8 +0,0 @@
-{
-  "tag": "3.2.0",
-  "distance": 0,
-  "node": "g7c8410160ff259451a9478f2f563f8a1188e1ed7",
-  "dirty": true,
-  "branch": "HEAD",
-  "node_date": "2026-09-16"
-}

pyoptik-3.2.0/docs/images/logo.svg

@@ -1 +0,0 @@
-<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 1500 420"><g transform="translate(35 45)"><path d="M165 25 300 280H30Z" fill="#123b75"/><path d="M165 25 165 280 30 280Z" fill="#2371c7"/><path d="M-10 194 165 164" stroke="#f4fbff" stroke-width="17"/><path d="M165 164 340 105M165 164 350 164M165 164 340 223" stroke-linecap="round" fill="none" stroke-width="13"/><path d="M165 164 340 105" stroke="#16bfe4" stroke-width="13"/><path d="M165 164 350 164" stroke="#23c99e" stroke-width="13"/><path d="M165 164 340 223" stroke="#f2ae3a" stroke-width="13"/></g><text x="430" y="190" font-family="Avenir Next,Arial,sans-serif" font-size="150" font-weight="700" fill="#102d5c">PyOptik</text><text x="437" y="264" font-family="Avenir Next,Arial,sans-serif" font-size="36" font-weight="600" letter-spacing="8" fill="#35669c">REFRACTIVE INDEX LIBRARY</text></svg>

pyoptik-3.2.0/docs/source/_static/logo.svg

@@ -1 +0,0 @@
-<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 1500 420"><g transform="translate(35 45)"><path d="M165 25 300 280H30Z" fill="#123b75"/><path d="M165 25 165 280 30 280Z" fill="#2371c7"/><path d="M-10 194 165 164" stroke="#f4fbff" stroke-width="17"/><path d="M165 164 340 105M165 164 350 164M165 164 340 223" stroke-linecap="round" fill="none" stroke-width="13"/><path d="M165 164 340 105" stroke="#16bfe4" stroke-width="13"/><path d="M165 164 350 164" stroke="#23c99e" stroke-width="13"/><path d="M165 164 340 223" stroke="#f2ae3a" stroke-width="13"/></g><text x="430" y="190" font-family="Avenir Next,Arial,sans-serif" font-size="150" font-weight="700" fill="#102d5c">PyOptik</text><text x="437" y="264" font-family="Avenir Next,Arial,sans-serif" font-size="36" font-weight="600" letter-spacing="8" fill="#35669c">REFRACTIVE INDEX LIBRARY</text></svg>