PyOptik 1.5.0.post0__tar.gz → 1.6.1.post0__tar.gz

pyoptik-1.5.0.post0/.github/workflows/coverage.yml → pyoptik-1.6.1.post0/.github/workflows/deploy_coverage.yml

@@ -1,11 +1,14 @@
-# .github/workflows/coverage.yml
+# .github/workflows/deploy_coverage.yml
 name: Coverage
 
 on:
-  pull_request:
-    branches: "master"
   push:
-    branches: "master"
+    branches: [ "master" ]
+    tags:
+      - '*'
+  pull_request:
+    branches: [ "master" ]
+
 
 jobs:
   coverage:
@@ -14,14 +17,14 @@ jobs:
     permissions:
       pull-requests: write
       contents: write
+
     steps:
-      - name: "Set-up: Python ${{ env.cp_python_version }}"
+      - name: "Set-up: Python 3.10"
         uses: actions/setup-python@v4
         id: cp310
         with:
             python-version: "3.10"
 
-
       - name: "Install: Dependencies for headless server"
         shell: bash
         run: |
@@ -42,8 +45,10 @@ jobs:
           pytest
 
       - name: Coverage comment
+        if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
         uses: py-cov-action/python-coverage-comment-action@v3
         with:
+          GITHUB_PR_RUN_ID: ${{ github.event.workflow_run.id }}
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           MINIMUM_GREEN: 90
           MINIMUM_ORANGE: 50

pyoptik-1.6.1.post0/.github/workflows/deploy_documentation.yml

@@ -0,0 +1,60 @@
+# .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.10"
+        uses: actions/setup-python@v4
+        id: cp310
+        with:
+            python-version: "3.10"
+
+      - name: "Install: Dependencies for headless server"
+        shell: bash
+        run: |
+            sudo apt-get update
+            sudo apt-get install libgl1-mesa-glx xvfb
+
+      - 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: Install dependencies
+        run: |
+          pip install sphinx sphinx_rtd_theme myst_parser
+
+      - name: Sphinx build
+        run: |
+          sphinx-build docs/source _build
+
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v3
+        if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
+        with:
+          publish_branch: gh-pages
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: _build/
+          force_orphan: true

pyoptik-1.6.1.post0/.github/workflows/deploy_workflow.yml

@@ -0,0 +1,30 @@
+name: Deploy Wheel
+
+on:
+  push:
+    branches: [ "master" ]
+    tags:
+      - '*'
+  pull_request:
+    branches: [ "master" ]
+
+permissions:
+    contents: write
+
+jobs:
+    build_pure_python:
+        runs-on: ubuntu-latest
+        steps:
+          - uses: MartinPdeS/MPSActions/build_pure_python_package@master
+            with:
+                python-version: '3.10'
+
+    publish_wheel:
+        if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
+        needs: [build_pure_python]
+        runs-on: ubuntu-latest
+        steps:
+          - uses: MartinPdeS/MPSActions/publish_pypi@master
+            with:
+                python-version: "3.10"
+                password: ${{ secrets.PYPI_API_TOKEN }}

{pyoptik-1.5.0.post0 → pyoptik-1.6.1.post0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: PyOptik
-Version: 1.5.0.post0
+Version: 1.6.1.post0
 Summary: A package for refractive index values.
 Author-email: Martin Poinsinet de Sivry-Houle <martin.poinsinet.de.sivry@gmail.com>
 License: MIT License
@@ -88,10 +88,10 @@ After installing PyOptik, you can easily access material properties:
 
 .. code:: python
 
-   from PyOptik import UsualMaterial
+   from PyOptik import Material
 
    # Access the refractive index of BK7 glass
-   bk7 = UsualMaterial.BK7
+   bk7 = Material.BK7
    n = bk7.compute_refractive_index(0.55e-6)
    print(f"Refractive index at 0.55 µm: {n}")
 
@@ -104,13 +104,13 @@ Here is a quick example demonstrating how to use PyOptik to retrieve and plot th
 .. code:: python
 
    import numpy as np
-   from PyOptik import UsualMaterial
+   from PyOptik import Material
 
    # Define wavelength range
    wavelengths = np.linspace(0.3e-6, 2.5e-6, 100)
 
    # Retrieve refractive index for BK7 glass
-   bk7 = UsualMaterial.BK7
+   bk7 = Material.BK7
    n_values = bk7.compute_refractive_index(wavelengths)
 
    # Plot the results
@@ -178,8 +178,9 @@ As of 2024, PyOptik is still under development. If you would like to collaborate
 
 .. |example_bk7| image:: https://github.com/MartinPdeS/PyOptik/blob/master/docs/images/example_bk7.png
 
-.. |docs| image:: https://readthedocs.org/projects/pyoptik/badge/?version=latest
-   :target: https://pyoptik.readthedocs.io/en/latest/
+.. |docs| image:: https://github.com/martinpdes/pyoptik/actions/workflows/deploy_documentation.yml/badge.svg
+   :target: https://martinpdes.github.io/PyOptik/
+   :alt: Documentation Status
 
 .. |PyPi| image:: https://badge.fury.io/py/pyoptik.svg
    :target: https://badge.fury.io/py/pyoptik

{pyoptik-1.5.0.post0 → pyoptik-1.6.1.post0}/PyOptik/__init__.py

@@ -8,4 +8,6 @@ except ImportError:
 from .utils import build_default_library
 from .material import Material
 from .tabulated_class import TabulatedMaterial
-from .sellmeier_class import SellmeierMaterial
+from .sellmeier_class import SellmeierMaterial
+
+Material = Material()

{pyoptik-1.5.0.post0 → pyoptik-1.6.1.post0}/PyOptik/_version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '1.5.0.post0'
-__version_tuple__ = version_tuple = (1, 5, 0)
+__version__ = version = '1.6.1.post0'
+__version_tuple__ = version_tuple = (1, 6, 1)

pyoptik-1.6.1.post0/PyOptik/material.py

@@ -0,0 +1,61 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+from typing import Union
+from PyOptik.sellmeier_class import SellmeierMaterial
+from PyOptik.tabulated_class import TabulatedMaterial
+from PyOptik import data
+
+class staticproperty(property):
+    """
+    A descriptor that mimics the behavior of a @property but for class-level access.
+
+    This allows a method to be accessed like a static property without the need to instantiate the class.
+    """
+    def __get__(self, owner_self, owner_cls):
+        return self.fget()
+
+class Material:
+    """
+    A class representing common materials available in the PyOptik library.
+
+    This class provides easy access to a predefined list of materials, either through static properties or
+    a dynamic getter method. Materials are categorized into Sellmeier and Tabulated materials.
+    """
+
+    all = [
+        'silver',
+        'gold',
+        'aluminium',
+        'copper',
+        'zinc',
+        'iron',
+        'argon',
+        'water',
+        'silicon',
+        'BK7',
+        'fused_silica',
+        'germanium',
+        'polystyren'
+    ]
+
+    def __getattr__(self, material_name: str) -> Union[SellmeierMaterial, TabulatedMaterial]:
+        """
+        Retrieve a material by name.
+
+        Args:
+            material_name (str): The name of the material to retrieve.
+
+        Returns:
+            Union[SellmeierMaterial, TabulatedMaterial]: An instance of the material if found.
+
+        Raises:
+            FileNotFoundError: If the material is not found in either the Sellmeier or Tabulated lists.
+        """
+        if material_name in data.sellmeier.material_list:
+            return SellmeierMaterial(material_name)
+
+        if material_name in data.tabulated.material_list:
+            return TabulatedMaterial(material_name)
+
+        raise FileNotFoundError(f'Material: [{material_name}] could not be found.')

{pyoptik-1.5.0.post0 → pyoptik-1.6.1.post0}/PyOptik.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: PyOptik
-Version: 1.5.0.post0
+Version: 1.6.1.post0
 Summary: A package for refractive index values.
 Author-email: Martin Poinsinet de Sivry-Houle <martin.poinsinet.de.sivry@gmail.com>
 License: MIT License
@@ -88,10 +88,10 @@ After installing PyOptik, you can easily access material properties:
 
 .. code:: python
 
-   from PyOptik import UsualMaterial
+   from PyOptik import Material
 
    # Access the refractive index of BK7 glass
-   bk7 = UsualMaterial.BK7
+   bk7 = Material.BK7
    n = bk7.compute_refractive_index(0.55e-6)
    print(f"Refractive index at 0.55 µm: {n}")
 
@@ -104,13 +104,13 @@ Here is a quick example demonstrating how to use PyOptik to retrieve and plot th
 .. code:: python
 
    import numpy as np
-   from PyOptik import UsualMaterial
+   from PyOptik import Material
 
    # Define wavelength range
    wavelengths = np.linspace(0.3e-6, 2.5e-6, 100)
 
    # Retrieve refractive index for BK7 glass
-   bk7 = UsualMaterial.BK7
+   bk7 = Material.BK7
    n_values = bk7.compute_refractive_index(wavelengths)
 
    # Plot the results
@@ -178,8 +178,9 @@ As of 2024, PyOptik is still under development. If you would like to collaborate
 
 .. |example_bk7| image:: https://github.com/MartinPdeS/PyOptik/blob/master/docs/images/example_bk7.png
 
-.. |docs| image:: https://readthedocs.org/projects/pyoptik/badge/?version=latest
-   :target: https://pyoptik.readthedocs.io/en/latest/
+.. |docs| image:: https://github.com/martinpdes/pyoptik/actions/workflows/deploy_documentation.yml/badge.svg
+   :target: https://martinpdes.github.io/PyOptik/
+   :alt: Documentation Status
 
 .. |PyPi| image:: https://badge.fury.io/py/pyoptik.svg
    :target: https://badge.fury.io/py/pyoptik

{pyoptik-1.5.0.post0 → pyoptik-1.6.1.post0}/PyOptik.egg-info/SOURCES.txt

@@ -4,7 +4,8 @@ LICENSE
 README.rst
 pyproject.toml
 .github/dependabot.yml
-.github/workflows/coverage.yml
+.github/workflows/deploy_coverage.yml
+.github/workflows/deploy_documentation.yml
 .github/workflows/deploy_workflow.yml
 PyOptik/__init__.py
 PyOptik/__main__.py
@@ -53,7 +54,6 @@ PyOptik/data/tabulated/sodium.yml
 PyOptik/data/tabulated/zinc.yml
 docs/Makefile
 docs/make.bat
-docs/deprecated/experiment_material.py
 docs/examples/README.rst
 docs/examples/create_sellmeier_file.py
 docs/examples/create_tabulated_file.py

{pyoptik-1.5.0.post0 → pyoptik-1.6.1.post0}/README.rst

@@ -30,10 +30,10 @@ After installing PyOptik, you can easily access material properties:
 
 .. code:: python
 
-   from PyOptik import UsualMaterial
+   from PyOptik import Material
 
    # Access the refractive index of BK7 glass
-   bk7 = UsualMaterial.BK7
+   bk7 = Material.BK7
    n = bk7.compute_refractive_index(0.55e-6)
    print(f"Refractive index at 0.55 µm: {n}")
 
@@ -46,13 +46,13 @@ Here is a quick example demonstrating how to use PyOptik to retrieve and plot th
 .. code:: python
 
    import numpy as np
-   from PyOptik import UsualMaterial
+   from PyOptik import Material
 
    # Define wavelength range
    wavelengths = np.linspace(0.3e-6, 2.5e-6, 100)
 
    # Retrieve refractive index for BK7 glass
-   bk7 = UsualMaterial.BK7
+   bk7 = Material.BK7
    n_values = bk7.compute_refractive_index(wavelengths)
 
    # Plot the results
@@ -120,8 +120,9 @@ As of 2024, PyOptik is still under development. If you would like to collaborate
 
 .. |example_bk7| image:: https://github.com/MartinPdeS/PyOptik/blob/master/docs/images/example_bk7.png
 
-.. |docs| image:: https://readthedocs.org/projects/pyoptik/badge/?version=latest
-   :target: https://pyoptik.readthedocs.io/en/latest/
+.. |docs| image:: https://github.com/martinpdes/pyoptik/actions/workflows/deploy_documentation.yml/badge.svg
+   :target: https://martinpdes.github.io/PyOptik/
+   :alt: Documentation Status
 
 .. |PyPi| image:: https://badge.fury.io/py/pyoptik.svg
    :target: https://badge.fury.io/py/pyoptik

{pyoptik-1.5.0.post0 → pyoptik-1.6.1.post0}/docs/examples/plot_bk7.py

@@ -10,7 +10,7 @@ import numpy
 from PyOptik import Material
 
 # Initialize the material with the Sellmeier model
-material = Material.get('BK7')
+material = Material.BK7
 
 # Calculate refractive index at specific wavelengths
 RI = material.compute_refractive_index(wavelength=[1310e-9, 1550e-9])

{pyoptik-1.5.0.post0 → pyoptik-1.6.1.post0}/docs/examples/plot_sf5.py

@@ -10,7 +10,7 @@ import numpy
 from PyOptik import Material
 
 # Initialize the material with the Sellmeier model
-material = Material.get('SF5')
+material = Material.SF5
 
 # Calculate refractive index at specific wavelengths
 RI = material.compute_refractive_index(wavelength=[1310e-9, 1550e-9])

{pyoptik-1.5.0.post0 → pyoptik-1.6.1.post0}/docs/source/gallery/create_sellmeier_file.ipynb

@@ -15,7 +15,7 @@
       },
       "outputs": [],
       "source": [
-        "from PyOptik.utils import create_sellmeier_file\nfrom PyOptik.directories import sellmeier_data_path\nfrom PyOptik import SellmeierMaterial\n\n# Define the file properties\nfilename = 'example_sellmeier'\ncoefficients = [1.0, 0.5, 0.2, 0.1, 0.05]\nformula_type = 1\n\n# Call the function to create the file\ncreate_sellmeier_file(\n    filename=filename,\n    coefficients=coefficients,\n    formula_type=formula_type,\n    wavelength_range=(0.2, 2.0),\n    reference=\"Sample Reference\",\n    comments=\"This is a sample Sellmeier file created for demonstration purposes.\"\n)\n\nprint(f\"Sellmeier YAML file {filename}.yml has been created in {sellmeier_data_path}\")\n\nm = SellmeierMaterial('example_download')\n\nm.plot()"
+        "from PyOptik.utils import create_sellmeier_file\nfrom PyOptik.directories import sellmeier_data_path\nfrom PyOptik import SellmeierMaterial\n\n# Define the file properties\nfilename = 'example_sellmeier'\ncoefficients = [1.0, 0.5, 0.2, 0.1, 0.05]\nformula_type = 1\n\n# Call the function to create the file\ncreate_sellmeier_file(\n    filename=filename,\n    coefficients=coefficients,\n    formula_type=formula_type,\n    wavelength_range=(0.2, 2.0),\n    reference=\"Sample Reference\",\n    comments=\"This is a sample Sellmeier file created for demonstration purposes. \"\n)\n\nprint(f\"Sellmeier YAML file {filename}.yml has been created in {sellmeier_data_path}\")\n\nm = SellmeierMaterial(filename)\n\nm.plot()"
       ]
     }
   ],

{pyoptik-1.5.0.post0 → pyoptik-1.6.1.post0}/docs/source/gallery/create_sellmeier_file.py

@@ -22,11 +22,11 @@ create_sellmeier_file(
     formula_type=formula_type,
     wavelength_range=(0.2, 2.0),
     reference="Sample Reference",
-    comments="This is a sample Sellmeier file created for demonstration purposes."
+    comments="This is a sample Sellmeier file created for demonstration purposes. "
 )
 
 print(f"Sellmeier YAML file {filename}.yml has been created in {sellmeier_data_path}")
 
-m = SellmeierMaterial('example_download')
+m = SellmeierMaterial(filename)
 
 m.plot()

pyoptik-1.6.1.post0/docs/source/gallery/create_sellmeier_file.py.md5

@@ -0,0 +1 @@
+c2d99c841171626064930a1bf9572c7a

{pyoptik-1.5.0.post0 → pyoptik-1.6.1.post0}/docs/source/gallery/create_sellmeier_file.rst

@@ -40,6 +40,10 @@ This example demonstrates how to create a custom Sellmeier YAML file using the
 
     Sellmeier data saved to /Users/martinpdes/Desktop/GitProject/PyOptik/PyOptik/data/sellmeier/example_sellmeier.yml
     Sellmeier YAML file example_sellmeier.yml has been created in /Users/martinpdes/Desktop/GitProject/PyOptik/PyOptik/data/sellmeier
+    /Users/martinpdes/Desktop/GitProject/PyOptik/PyOptik/sellmeier_class.py:70: UserWarning: Wavelength 0.19999999999999998 µm is outside the allowable range of 0.2 µm to 2.0 µm. [example_sellmeier]
+      warnings.warn(f"Wavelength {lambda_um} µm is outside the allowable range of {min_value} µm to {max_value} µm. [{self.filename}]")
+    /Users/martinpdes/Desktop/GitProject/PyOptik/PyOptik/sellmeier_class.py:104: RuntimeWarning: invalid value encountered in sqrt
+      n = numpy.sqrt(n_squared)
 
 
 
@@ -67,19 +71,19 @@ This example demonstrates how to create a custom Sellmeier YAML file using the
         formula_type=formula_type,
         wavelength_range=(0.2, 2.0),
         reference="Sample Reference",
-        comments="This is a sample Sellmeier file created for demonstration purposes."
+        comments="This is a sample Sellmeier file created for demonstration purposes. "
     )
 
     print(f"Sellmeier YAML file {filename}.yml has been created in {sellmeier_data_path}")
 
-    m = SellmeierMaterial('example_download')
+    m = SellmeierMaterial(filename)
 
     m.plot()
 
 
 .. rst-class:: sphx-glr-timing
 
-   **Total running time of the script:** (0 minutes 0.146 seconds)
+   **Total running time of the script:** (0 minutes 0.165 seconds)
 
 
 .. _sphx_glr_download_gallery_create_sellmeier_file.py:

{pyoptik-1.5.0.post0 → pyoptik-1.6.1.post0}/docs/source/gallery/create_tabulated_file.ipynb

@@ -15,7 +15,7 @@
       },
       "outputs": [],
       "source": [
-        "from PyOptik.utils import create_tabulated_file\nfrom PyOptik.directories import tabulated_data_path\nfrom PyOptik import TabulatedMaterial\n\n# Define the tabulated data (wavelength in micrometers, n, k)\ntabulated_data = [\n    (0.1879, 0.94, 1.337),\n    (0.1916, 0.95, 1.388),\n    (0.1953, 0.97, 1.440),\n    (0.1993, 0.98, 1.493),\n    (0.2033, 0.99, 1.550),\n]\n\n# Define the file properties\nfilename = 'example_tabulated'\nreference = \"Example Reference for Tabulated Data\"\ncomments = \"This file contains sample tabulated data for demonstration purposes.\"\n\n# Call the function to create the file\ncreate_tabulated_file(\n    filename=filename,\n    data=tabulated_data,\n    reference=reference,\n    comments=comments\n)\n\nprint(f\"Tabulated YAML file {filename}.yml has been created in {tabulated_data_path}\")\n\nm = TabulatedMaterial('example_tabulated')\n\nm.plot()"
+        "from PyOptik.utils import create_tabulated_file\nfrom PyOptik.directories import tabulated_data_path\nfrom PyOptik import TabulatedMaterial\n\n# Define the tabulated data (wavelength in micrometers, n, k)\ntabulated_data = [\n    (0.1879, 0.94, 1.337),\n    (0.1916, 0.95, 1.388),\n    (0.1953, 0.97, 1.440),\n    (0.1993, 0.98, 1.493),\n    (0.2033, 0.99, 1.550),\n]\n\n# Define the file properties\nfilename = 'example_tabulated'\nreference = \"Example Reference for Tabulated Data\"\ncomments = \"This file contains sample tabulated data for demonstration purposes. \"\n\n# Call the function to create the file\ncreate_tabulated_file(\n    filename=filename,\n    data=tabulated_data,\n    reference=reference,\n    comments=comments\n)\n\nprint(f\"Tabulated YAML file {filename}.yml has been created in {tabulated_data_path}\")\n\nm = TabulatedMaterial(filename)\n\nm.plot()"
       ]
     }
   ],

{pyoptik-1.5.0.post0 → pyoptik-1.6.1.post0}/docs/source/gallery/create_tabulated_file.py

@@ -22,7 +22,7 @@ tabulated_data = [
 # Define the file properties
 filename = 'example_tabulated'
 reference = "Example Reference for Tabulated Data"
-comments = "This file contains sample tabulated data for demonstration purposes."
+comments = "This file contains sample tabulated data for demonstration purposes. "
 
 # Call the function to create the file
 create_tabulated_file(
@@ -34,6 +34,6 @@ create_tabulated_file(
 
 print(f"Tabulated YAML file {filename}.yml has been created in {tabulated_data_path}")
 
-m = TabulatedMaterial('example_tabulated')
+m = TabulatedMaterial(filename)
 
 m.plot()

pyoptik-1.6.1.post0/docs/source/gallery/create_tabulated_file.py.md5

@@ -0,0 +1 @@
+4a0ef6e1d962526bc360d253b71c2069

{pyoptik-1.5.0.post0 → pyoptik-1.6.1.post0}/docs/source/gallery/create_tabulated_file.rst

@@ -67,7 +67,7 @@ This example demonstrates how to create a custom YAML file containing tabulated
     # Define the file properties
     filename = 'example_tabulated'
     reference = "Example Reference for Tabulated Data"
-    comments = "This file contains sample tabulated data for demonstration purposes."
+    comments = "This file contains sample tabulated data for demonstration purposes. "
 
     # Call the function to create the file
     create_tabulated_file(
@@ -79,14 +79,14 @@ This example demonstrates how to create a custom YAML file containing tabulated
 
     print(f"Tabulated YAML file {filename}.yml has been created in {tabulated_data_path}")
 
-    m = TabulatedMaterial('example_tabulated')
+    m = TabulatedMaterial(filename)
 
     m.plot()
 
 
 .. rst-class:: sphx-glr-timing
 
-   **Total running time of the script:** (0 minutes 0.135 seconds)
+   **Total running time of the script:** (0 minutes 0.134 seconds)
 
 
 .. _sphx_glr_download_gallery_create_tabulated_file.py:

{pyoptik-1.5.0.post0 → pyoptik-1.6.1.post0}/docs/source/gallery/plot_bk7.ipynb

@@ -15,7 +15,7 @@
       },
       "outputs": [],
       "source": [
-        "import numpy\nfrom PyOptik import UsualMaterial\n\n# Initialize the material with the Sellmeier model\nmaterial = UsualMaterial.get('BK7')\n\n# Calculate refractive index at specific wavelengths\nRI = material.compute_refractive_index(wavelength=[1310e-9, 1550e-9])\n\n# Display calculated refractive indices at sample wavelengths\nmaterial.plot(\n    wavelength=numpy.linspace(300e-9, 1500e-9, 300)\n)"
+        "import numpy\nfrom PyOptik import Material\n\n# Initialize the material with the Sellmeier model\nmaterial = Material.BK7\n\n# Calculate refractive index at specific wavelengths\nRI = material.compute_refractive_index(wavelength=[1310e-9, 1550e-9])\n\n# Display calculated refractive indices at sample wavelengths\nmaterial.plot(\n    wavelength=numpy.linspace(300e-9, 1500e-9, 300)\n)"
       ]
     }
   ],

{pyoptik-1.5.0.post0 → pyoptik-1.6.1.post0}/docs/source/gallery/plot_bk7.py

@@ -7,10 +7,10 @@ This module demonstrates the usage of the PyOptik library to calculate and plot
 """
 
 import numpy
-from PyOptik import UsualMaterial
+from PyOptik import Material
 
 # Initialize the material with the Sellmeier model
-material = UsualMaterial.get('BK7')
+material = Material.BK7
 
 # Calculate refractive index at specific wavelengths
 RI = material.compute_refractive_index(wavelength=[1310e-9, 1550e-9])

pyoptik-1.6.1.post0/docs/source/gallery/plot_bk7.py.md5

@@ -0,0 +1 @@
+2099847e1a79f849101ef3d50c1c7882

{pyoptik-1.5.0.post0 → pyoptik-1.6.1.post0}/docs/source/gallery/plot_bk7.rst

@@ -40,10 +40,10 @@ This module demonstrates the usage of the PyOptik library to calculate and plot
 
 
     import numpy
-    from PyOptik import UsualMaterial
+    from PyOptik import Material
 
     # Initialize the material with the Sellmeier model
-    material = UsualMaterial.get('BK7')
+    material = Material.BK7
 
     # Calculate refractive index at specific wavelengths
     RI = material.compute_refractive_index(wavelength=[1310e-9, 1550e-9])
@@ -55,7 +55,7 @@ This module demonstrates the usage of the PyOptik library to calculate and plot
 
 .. rst-class:: sphx-glr-timing
 
-   **Total running time of the script:** (0 minutes 0.118 seconds)
+   **Total running time of the script:** (0 minutes 0.098 seconds)
 
 
 .. _sphx_glr_download_gallery_plot_bk7.py:

{pyoptik-1.5.0.post0 → pyoptik-1.6.1.post0}/docs/source/gallery/plot_sf5.ipynb

@@ -15,7 +15,7 @@
       },
       "outputs": [],
       "source": [
-        "import numpy\nfrom PyOptik import UsualMaterial\n\n# Initialize the material with the Sellmeier model\nmaterial = UsualMaterial.get('SF5')\n\n# Calculate refractive index at specific wavelengths\nRI = material.compute_refractive_index(wavelength=[1310e-9, 1550e-9])\n\n# Display calculated refractive indices at sample wavelengths\nmaterial.plot(\n    wavelength=numpy.linspace(400e-9, 1500e-9, 300)\n)"
+        "import numpy\nfrom PyOptik import Material\n\n# Initialize the material with the Sellmeier model\nmaterial = Material.SF5\n\n# Calculate refractive index at specific wavelengths\nRI = material.compute_refractive_index(wavelength=[1310e-9, 1550e-9])\n\n# Display calculated refractive indices at sample wavelengths\nmaterial.plot(\n    wavelength=numpy.linspace(400e-9, 1500e-9, 300)\n)"
       ]
     }
   ],

{pyoptik-1.5.0.post0 → pyoptik-1.6.1.post0}/docs/source/gallery/plot_sf5.py

@@ -7,10 +7,10 @@ This module demonstrates the usage of the PyOptik library to calculate and plot
 """
 
 import numpy
-from PyOptik import UsualMaterial
+from PyOptik import Material
 
 # Initialize the material with the Sellmeier model
-material = UsualMaterial.get('SF5')
+material = Material.SF5
 
 # Calculate refractive index at specific wavelengths
 RI = material.compute_refractive_index(wavelength=[1310e-9, 1550e-9])

pyoptik-1.6.1.post0/docs/source/gallery/plot_sf5.py.md5

@@ -0,0 +1 @@
+e7d07cb7b88abc68d4b21a5d0e3596e7

{pyoptik-1.5.0.post0 → pyoptik-1.6.1.post0}/docs/source/gallery/plot_sf5.rst

@@ -40,10 +40,10 @@ This module demonstrates the usage of the PyOptik library to calculate and plot
 
 
     import numpy
-    from PyOptik import UsualMaterial
+    from PyOptik import Material
 
     # Initialize the material with the Sellmeier model
-    material = UsualMaterial.get('SF5')
+    material = Material.SF5
 
     # Calculate refractive index at specific wavelengths
     RI = material.compute_refractive_index(wavelength=[1310e-9, 1550e-9])
@@ -56,7 +56,7 @@ This module demonstrates the usage of the PyOptik library to calculate and plot
 
 .. rst-class:: sphx-glr-timing
 
-   **Total running time of the script:** (0 minutes 0.117 seconds)
+   **Total running time of the script:** (0 minutes 0.105 seconds)
 
 
 .. _sphx_glr_download_gallery_plot_sf5.py:

{pyoptik-1.5.0.post0 → pyoptik-1.6.1.post0}/docs/source/gallery/plot_silica.ipynb

@@ -15,7 +15,7 @@
       },
       "outputs": [],
       "source": [
-        "import numpy\nfrom PyOptik import UsualMaterial\n\n# Initialize the material with the Sellmeier model\nmaterial = UsualMaterial.fused_silica\n\n# Calculate refractive index at specific wavelengths\nRI = material.compute_refractive_index(wavelength=[1310e-9, 1550e-9])\n\n# Display calculated refractive indices at sample wavelengths\nmaterial.plot(\n    wavelength=numpy.linspace(500e-9, 1500e-9, 300)\n)"
+        "import numpy\nfrom PyOptik import Material\n\n# Initialize the material with the Sellmeier model\nmaterial = Material.fused_silica\n\n# Calculate refractive index at specific wavelengths\nRI = material.compute_refractive_index(wavelength=[1310e-9, 1550e-9])\n\n# Display calculated refractive indices at sample wavelengths\nmaterial.plot(\n    wavelength=numpy.linspace(500e-9, 1500e-9, 300)\n)"
       ]
     }
   ],