PyOptik 1.4.1.post0__tar.gz → 1.6.0.post0__tar.gz

pyoptik-1.4.1.post0/.github/workflows/coverage.yml → pyoptik-1.6.0.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.0.post0/.github/workflows/deploy_documentation.yml

@@ -0,0 +1,57 @@
+# .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: "Build: documentation"
+        shell: bash
+        run: |
+            make -C docs html
+
+      - name: "Upload: GitHub Pages"
+        if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
+        uses: crazy-max/ghaction-github-pages@v3
+        with:
+            target_branch: gh-pages
+            build_dir: docs/build/html
+        env:
+            GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

pyoptik-1.6.0.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.4.1.post0 → pyoptik-1.6.0.post0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: PyOptik
-Version: 1.4.1.post0
+Version: 1.6.0.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://pyoptik.readthedocs.io/en/latest/code.html
+   :alt: Documentation Status
 
 .. |PyPi| image:: https://badge.fury.io/py/pyoptik.svg
    :target: https://badge.fury.io/py/pyoptik

{pyoptik-1.4.1.post0 → pyoptik-1.6.0.post0}/PyOptik/__init__.py

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

{pyoptik-1.4.1.post0 → pyoptik-1.6.0.post0}/PyOptik/_version.py

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

{pyoptik-1.4.1.post0 → pyoptik-1.6.0.post0}/PyOptik/base_class.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
 
-class Material:
+class BaseMaterial:
     def __str__(self) -> str:
         """
         Provides an informal string representation of the Material object.

pyoptik-1.6.0.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.4.1.post0 → pyoptik-1.6.0.post0}/PyOptik/sellmeier_class.py

@@ -9,11 +9,11 @@ import yaml
 from PyOptik.directories import sellmeier_data_path
 import itertools
 import warnings
-from PyOptik.base_class import Material
+from PyOptik.base_class import BaseMaterial
 from MPSPlots.styles import mps
 
 @dataclass
-class SellmeierMaterial(Material):
+class SellmeierMaterial(BaseMaterial):
     filename: str
     coefficients: numpy.ndarray = field(init=False)
     wavelength_range: Optional[Tuple[float, float]] = field(init=False)

{pyoptik-1.4.1.post0 → pyoptik-1.6.0.post0}/PyOptik/tabulated_class.py

@@ -8,12 +8,12 @@ import yaml
 from scipy.interpolate import interp1d
 import warnings
 from PyOptik.directories import tabulated_data_path
-from PyOptik.base_class import Material
+from PyOptik.base_class import BaseMaterial
 from MPSPlots.styles import mps
 import matplotlib.pyplot as plt
 
 @dataclass
-class TabulatedMaterial(Material):
+class TabulatedMaterial(BaseMaterial):
     filename: str
     wavelength: numpy.ndarray = field(init=False)
     n_values: numpy.ndarray = field(init=False)

{pyoptik-1.4.1.post0 → pyoptik-1.6.0.post0}/PyOptik.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: PyOptik
-Version: 1.4.1.post0
+Version: 1.6.0.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://pyoptik.readthedocs.io/en/latest/code.html
+   :alt: Documentation Status
 
 .. |PyPi| image:: https://badge.fury.io/py/pyoptik.svg
    :target: https://badge.fury.io/py/pyoptik

{pyoptik-1.4.1.post0 → pyoptik-1.6.0.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.4.1.post0 → pyoptik-1.6.0.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://pyoptik.readthedocs.io/en/latest/code.html
+   :alt: Documentation Status
 
 .. |PyPi| image:: https://badge.fury.io/py/pyoptik.svg
    :target: https://badge.fury.io/py/pyoptik

{pyoptik-1.4.1.post0/docs/source/gallery → pyoptik-1.6.0.post0/docs/examples}/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.4.1.post0/docs/source/gallery → pyoptik-1.6.0.post0/docs/examples}/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.4.1.post0/docs/source/gallery → pyoptik-1.6.0.post0/docs/examples}/plot_silica.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.fused_silica
+material = Material.fused_silica
 
 # Calculate refractive index at specific wavelengths
 RI = material.compute_refractive_index(wavelength=[1310e-9, 1550e-9])

{pyoptik-1.4.1.post0/docs/source/gallery → pyoptik-1.6.0.post0/docs/examples}/plot_silver.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.silver
+material = Material.silver
 
 # Calculate refractive index at specific wavelengths
 RI = material.compute_refractive_index(wavelength=[1310e-9, 1550e-9])

{pyoptik-1.4.1.post0/docs/source/gallery → pyoptik-1.6.0.post0/docs/examples}/plot_water.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.water
+material = Material.water
 
 # Calculate refractive index at specific wavelengths
 RI = material.compute_refractive_index(wavelength=[800e-9, 900e-9])

pyoptik-1.6.0.post0/tests/test_usual_material.py

@@ -0,0 +1,16 @@
+import pytest
+from PyOptik import Material
+from PyOptik.material import SellmeierMaterial, TabulatedMaterial
+
+@pytest.mark.parametrize('material_name', Material.all, ids=lambda name: f'Test {name}')
+def test_usual_material(material_name):
+    """
+    Test each usual material defined in UsualMaterial to ensure that it can be instantiated without errors.
+    """
+    material_instance = getattr(Material, material_name)
+
+    assert isinstance(material_instance, (SellmeierMaterial, TabulatedMaterial)), f"{material_name} instantiation failed."
+
+
+if __name__ == "__main__":
+    pytest.main([__file__])

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

@@ -1,41 +0,0 @@
-name: Deploy
-
-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_documentation:
-        if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
-        needs: [build_pure_python]
-        runs-on: ubuntu-latest
-        steps:
-          - uses: MartinPdeS/MPSActions/publish_documentation@master
-            with:
-                GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-                package-name: PyOptik
-                python-version: "3.10" #no documentation for python 3.7 (pickle5 not present˘)
-
-    publish_wheel:
-        if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
-        needs: [build_pure_python, publish_documentation]
-        runs-on: ubuntu-latest
-        steps:
-          - uses: MartinPdeS/MPSActions/publish_pypi@master
-            with:
-                python-version: "3.10"
-                password: ${{ secrets.PYPI_API_TOKEN }}

pyoptik-1.4.1.post0/PyOptik/material.py

@@ -1,129 +0,0 @@
-#!/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 UsualMaterial:
-    """
-    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_materials = [
-        'silver',
-        'gold',
-        'aluminium',
-        'copper',
-        'zinc',
-        'iron',
-        'argon',
-        'water',
-        'silicon',
-        'BK7',
-        'fused_silica',
-        'germanium',
-        'polystyren'
-    ]
-
-    @staticmethod
-    def get(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.')
-
-    # Static properties for each material
-
-    @staticproperty
-    def silver() -> TabulatedMaterial:
-        """Get the TabulatedMaterial instance for silver."""
-        return TabulatedMaterial('silver')
-
-    @staticproperty
-    def gold() -> TabulatedMaterial:
-        """Get the TabulatedMaterial instance for gold."""
-        return TabulatedMaterial('gold')
-
-    @staticproperty
-    def aluminium() -> TabulatedMaterial:
-        """Get the TabulatedMaterial instance for aluminium."""
-        return TabulatedMaterial('aluminium')
-
-    @staticproperty
-    def copper() -> TabulatedMaterial:
-        """Get the TabulatedMaterial instance for copper."""
-        return TabulatedMaterial('copper')
-
-    @staticproperty
-    def zinc() -> TabulatedMaterial:
-        """Get the TabulatedMaterial instance for zinc."""
-        return TabulatedMaterial('zinc')
-
-    @staticproperty
-    def iron() -> TabulatedMaterial:
-        """Get the TabulatedMaterial instance for iron."""
-        return TabulatedMaterial('iron')
-
-    @staticproperty
-    def polystyren() -> SellmeierMaterial:
-        """Get the SellmeierMaterial instance for polystyren."""
-        return SellmeierMaterial('polystyren')
-
-    @staticproperty
-    def argon() -> SellmeierMaterial:
-        """Get the SellmeierMaterial instance for argon."""
-        return SellmeierMaterial('argon')
-
-    @staticproperty
-    def water() -> SellmeierMaterial:
-        """Get the SellmeierMaterial instance for water."""
-        return SellmeierMaterial('water')
-
-    @staticproperty
-    def silicon() -> SellmeierMaterial:
-        """Get the SellmeierMaterial instance for silicon."""
-        return SellmeierMaterial('silicon')
-
-    @staticproperty
-    def BK7() -> SellmeierMaterial:
-        """Get the SellmeierMaterial instance for BK7."""
-        return SellmeierMaterial('BK7')
-
-    @staticproperty
-    def fused_silica() -> SellmeierMaterial:
-        """Get the SellmeierMaterial instance for fused_silica."""
-        return SellmeierMaterial('fused_silica')
-
-    @staticproperty
-    def germanium() -> SellmeierMaterial:
-        """Get the SellmeierMaterial instance for germanium."""
-        return SellmeierMaterial('germanium')