PyOptik 0.7.11__tar.gz → 0.7.16.post0__tar.gz

pyoptik-0.7.16.post0/.github/dependabot.yml

@@ -0,0 +1,11 @@
+# Specify reviewers for pull requests
+
+version: 2
+updates:
+  - package-ecosystem: "pip"
+    directory: "/"
+    target-branch: "master"
+    schedule:
+      interval: "weekly"
+      day: "sunday"
+      time: "09:00"

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

@@ -0,0 +1,53 @@
+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_coverage:
+        if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
+        needs: [build_pure_python]
+        runs-on: ubuntu-latest
+        steps:
+          - uses: MartinPdeS/MPSActions/publish_coverage@master
+            with:
+                package-name: PyOptik
+                python-version: "3.10"
+                auth: ${{ secrets.GIST_TOKEN }} 
+                gistID: 8fa5a7d93dc020b1f624012220f6ebbd
+
+    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, publish_coverage]
+        runs-on: ubuntu-latest
+        steps:
+          - uses: MartinPdeS/MPSActions/publish_pypi@master
+            with:
+                python-version: "3.10"
+                password: ${{ secrets.PYPI_API_TOKEN }}

pyoptik-0.7.16.post0/.gitignore

@@ -0,0 +1,15 @@
+*.DS_store
+*.ipynb_checkpoints*
+*__pycache__*
+*.so
+*.pytest_cache
+
+dist
+build
+*.egg*
+perso/
+
+CMakeCache.txt
+CMakeFiles
+install_manifest.txt
+cmake_install.cmake

pyoptik-0.7.16.post0/.readthedocs.yml

@@ -0,0 +1,35 @@
+# .readthedocs.yml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+submodules:
+  include: all
+  recursive: true
+
+build:
+  os: ubuntu-22.04
+
+
+  tools:
+    python: "3.10"
+  jobs:
+    pre_install:
+      - Xvfb :99 &
+      - export DISPLAY=:99
+      - cd docs && rm -rf source/gallery
+      - sleep 3
+
+python:
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - documentation
+
+sphinx:
+  builder: html
+  configuration: docs/source/conf.py
+  fail_on_warning: false

{pyoptik-0.7.11 → pyoptik-0.7.16.post0}/PKG-INFO

@@ -1,18 +1,33 @@
 Metadata-Version: 2.1
 Name: PyOptik
-Version: 0.7.11
-Summary: A package/library for refractive index values.
-Home-page: https://github.com/MartinPdeS/PyOptik
-Author: Martin Poinsinet de Sivry
-Author-email: Martin.poinsinet.de.sivry@gmail.com
-License: MIT
-Keywords: refractive index
-Platform: unix
-Platform: linux
-Platform: osx
+Version: 0.7.16.post0
+Summary: A package for refractive index values.
+Author-email: Martin Poinsinet de Sivry-Houle <martin.poinsinet.de.sivry@gmail.com>
+License: MIT License
+        
+        Copyright (c) 2020 Martin de Sivry
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Keywords: refracive index,optics
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: Implementation :: CPython
@@ -20,22 +35,14 @@ Classifier: Development Status :: 4 - Beta
 Classifier: Topic :: Scientific/Engineering :: Physics
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Intended Audience :: Science/Research
+Requires-Python: >=3.10
 Description-Content-Type: text/x-rst
 License-File: LICENSE
-Requires-Dist: pydantic==2.6.3
-Requires-Dist: matplotlib==3.8.2
-Requires-Dist: numpy>=1.26.0
-Requires-Dist: requests==2.31.0
-Requires-Dist: pandas==2.1.1
-Requires-Dist: bs4==0.0.1
-Requires-Dist: MPSTools==0.2.3
-Requires-Dist: MPSPlots>=1.4.2
-Provides-Extra: documentation
-Requires-Dist: numpydoc==1.6.0; extra == "documentation"
-Requires-Dist: sphinx>=5.1.1; extra == "documentation"
-Requires-Dist: sphinx-gallery==0.15.0; extra == "documentation"
-Requires-Dist: sphinx-rtd-theme==2.0.0; extra == "documentation"
-Requires-Dist: pydata-sphinx-theme==0.14.1; extra == "documentation"
+Requires-Dist: pydantic>=2.6.3
+Requires-Dist: numpy
+Requires-Dist: scipy
+Requires-Dist: MPSTools
+Requires-Dist: tabulate
 Provides-Extra: testing
 Requires-Dist: pytest>=0.6; extra == "testing"
 Requires-Dist: pytest-cov>=2.0; extra == "testing"
@@ -44,7 +51,12 @@ Requires-Dist: mypy>=0.910; extra == "testing"
 Requires-Dist: flake8>=3.9; extra == "testing"
 Requires-Dist: tox>=3.24; extra == "testing"
 Requires-Dist: coverage==6.5.0; extra == "testing"
-Requires-Dist: PyMieScatt==1.8.1.1; extra == "testing"
+Provides-Extra: documentation
+Requires-Dist: numpydoc==1.6.0; extra == "documentation"
+Requires-Dist: sphinx>=5.1.1; extra == "documentation"
+Requires-Dist: sphinx-gallery==0.15.0; extra == "documentation"
+Requires-Dist: sphinx-rtd-theme==2.0.0; extra == "documentation"
+Requires-Dist: pydata-sphinx-theme==0.14.1; extra == "documentation"
 
 |Logo|
 

{pyoptik-0.7.11 → pyoptik-0.7.16.post0}/PyOptik/__init__.py

@@ -4,6 +4,13 @@ import numpy
 import pandas
 
 
+try:
+    from ._version import version as __version__  # noqa: F401
+
+except ImportError:
+    __version__ = "0.0.0"
+
+
 class UsualMaterial:
     BK7 = Sellmeier('BK7')
     FusedSilica = Sellmeier('silica')

pyoptik-0.7.16.post0/PyOptik/_version.py

@@ -0,0 +1,16 @@
+# file generated by setuptools_scm
+# don't change, don't track in version control
+TYPE_CHECKING = False
+if TYPE_CHECKING:
+    from typing import Tuple, Union
+    VERSION_TUPLE = Tuple[Union[int, str], ...]
+else:
+    VERSION_TUPLE = object
+
+version: str
+__version__: str
+__version_tuple__: VERSION_TUPLE
+version_tuple: VERSION_TUPLE
+
+__version__ = version = '0.7.16.post0'
+__version_tuple__ = version_tuple = (0, 7, 16)

{pyoptik-0.7.11 → pyoptik-0.7.16.post0}/PyOptik/directories.py

@@ -1,7 +1,6 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
 
-import os
 from pathlib import Path
 import PyOptik
 
@@ -11,8 +10,7 @@ __all__ = [
     'project_path',
     'doc_path',
     'doc_css_path',
-    'logo_path',
-    'version_path',
+    'logo_path'
 ]
 
 root_path = Path(PyOptik.__path__[0])
@@ -27,16 +25,8 @@ doc_css_path = doc_path.joinpath('source/_static/default.css')
 
 logo_path = doc_path.joinpath('images/logo.png')
 
-version_path = root_path.joinpath('VERSION')
-
 examples_path = root_path.joinpath('examples')
 
-ZeroPath = os.path.dirname(root_path)
-
-DataPath = os.path.join(root_path, 'Data')
-
-NPZPath = os.path.join(DataPath, 'npz')
-
 
 if __name__ == '__main__':
     for path_name in __all__:

{pyoptik-0.7.11 → pyoptik-0.7.16.post0}/PyOptik/experiment_material.py

@@ -2,27 +2,26 @@
 # -*- coding: utf-8 -*-
 
 import os
-from typing import Union, Iterable
+from typing import Union, Iterable, NoReturn
 from MPSTools.material_catalogue.loader import get_material_index
-from MPSPlots.render2D import SceneList
-
+import matplotlib.pyplot as plt
 from MPSTools.tools.directories import measurements_file_path
 from pydantic.dataclasses import dataclass
 
 
-def valid_name(string):
+def valid_name(string: str) -> bool:
+    """Check if the provided string is a valid material name."""
     return not string.startswith('_')
 
 
+# List of available materials
 list_of_available_files = os.listdir(measurements_file_path)
-
 material_list = [element[:-5] for element in list_of_available_files]
-
 material_list = list(filter(valid_name, material_list))
 
 
 @dataclass
-class DataMeasurement():
+class DataMeasurement:
     """
     A class for computing the refractive index using locally saved measurement data for specified materials.
 
@@ -30,19 +29,18 @@ class DataMeasurement():
         material_name (str): The name of the material.
 
     Methods:
-        reference (str): Returns the bibliographic reference for the material's data.
+        reference: Returns the bibliographic reference for the material's data.
         get_refractive_index: Computes the refractive index for given wavelength(s).
         plot: Visualizes the refractive index as a function of wavelength.
     """
-
     material_name: str
 
     def __post_init__(self):
         """
         Initializes the DataMeasurement object with a specified material name.
 
-        Parameters:
-            material_name (str): The name of the material for which to compute the refractive index.
+        Raises:
+            ValueError: If the material_name is not in the list of available materials.
         """
         if self.material_name not in material_list:
             raise ValueError(f"{self.material_name} is not in the list of available materials.")
@@ -54,18 +52,21 @@ class DataMeasurement():
 
         Returns:
             str: The bibliographic reference for the material's measurement data.
+
+        Raises:
+            NotImplementedError: If the feature is not implemented yet.
         """
         raise NotImplementedError("Feature not implemented yet.")
 
-    def get_refractive_index(self, wavelength_range: Union[float, Iterable]) -> Union[float, Iterable]:
+    def get_refractive_index(self, wavelength_range: Union[float, Iterable[float]]) -> Union[float, Iterable[float]]:
         """
         Computes the refractive index for the specified wavelength range using the material's measurement data.
 
         Parameters:
-            wavelength_range (Union[float, Iterable]): The wavelength(s) in meters.
+            wavelength_range (Union[float, Iterable[float]]): The wavelength(s) in meters.
 
         Returns:
-            Union[float, Iterable]: The refractive index or indices for the specified wavelength(s).
+            Union[float, Iterable[float]]: The refractive index or indices for the specified wavelength(s).
         """
         return get_material_index(
             material_name=self.material_name,
@@ -73,23 +74,22 @@ class DataMeasurement():
             subdir='measurements'
         )
 
-    def plot(self, wavelength_range: Iterable) -> SceneList:
+    def plot(self, wavelength_range: Iterable[float]) -> NoReturn:
         """
         Generates a plot of the refractive index as a function of wavelength for the specified material.
 
         Parameters:
-            wavelength_range (Iterable): The range of wavelengths to plot.
-
-        Returns:
-            SceneList: An object containing the plot of refractive index against wavelength.
+            wavelength_range (Iterable[float]): The range of wavelengths to plot.
         """
-        scene = SceneList()
-        ax = scene.append_ax(x_label='Wavelength [m]', y_label='Refractive index')
+        figure, ax = plt.subplots(1, 1)
+        ax.set_xlabel('Wavelength [m]')
+        ax.set_ylabel('Refractive index')
 
         refractive_index = self.get_refractive_index(wavelength_range)
-        ax.add_line(x=wavelength_range, y=refractive_index, line_width=2)
+        ax.plot(wavelength_range, refractive_index.real, linewidth=2, label='real part')
+        ax.plot(wavelength_range, refractive_index.imag, linewidth=2, label='imag part')
 
-        return scene
+        plt.show()
 
     def __repr__(self) -> str:
         """
@@ -98,7 +98,7 @@ class DataMeasurement():
         Returns:
             str: Formal representation of the object, showing the material name.
         """
-        return str(self.material_name)
+        return f"DataMeasurement(material_name='{self.material_name}')"
 
     def __str__(self) -> str:
         """
@@ -107,6 +107,4 @@ class DataMeasurement():
         Returns:
             str: Informal representation of the object.
         """
-        return self.__repr__()
-
-# -
+        return self.material_name

{pyoptik-0.7.11 → pyoptik-0.7.16.post0}/PyOptik/sellmeier_material.py

@@ -2,33 +2,32 @@
 # -*- coding: utf-8 -*-
 
 import os
-import numpy as np
-from typing import Union, Iterable
+import numpy
+from typing import Union, Iterable, NoReturn
 from MPSTools.material_catalogue.loader import get_material_index
-from MPSPlots.render2D import SceneList
+import matplotlib.pyplot as plt
 from MPSTools.tools.directories import sellmeier_file_path
 from pydantic.dataclasses import dataclass
 
 
-def valid_name(string):
+def valid_name(string: str) -> bool:
+    """Check if the provided string is a valid material name."""
     return not string.startswith('_')
 
 
+# List of available materials
 list_of_available_files = os.listdir(sellmeier_file_path)
-
 material_list = [element[:-5] for element in list_of_available_files]
-
 material_list = list(filter(valid_name, material_list))
 
 
 @dataclass
-class Sellmeier():
+class Sellmeier:
     """
     A class for computing the refractive index using the Sellmeier equation based on locally stored Sellmeier coefficients.
 
     Attributes:
         material_name (str): Name of the material.
-        sellmeier_coefficients (dict): Sellmeier coefficients for the material loaded from a local source.
 
     Methods:
         reference: Returns the reference for the Sellmeier coefficients.
@@ -39,13 +38,18 @@ class Sellmeier():
 
     def __post_init__(self):
         """
-        Initializes the DataMeasurement object with a specified material name.
+        Initializes the Sellmeier object with a specified material name.
 
-        Parameters:
-            material_name (str): The name of the material for which to compute the refractive index.
+        Raises:
+            ValueError: If the material_name is not in the list of available materials.
         """
         if self.material_name not in material_list:
             raise ValueError(f"{self.material_name} is not in the list of available materials.")
+        self.sellmeier_coefficients = get_material_index(
+            material_name=self.material_name,
+            wavelength=numpy.array([1.0]),  # Dummy wavelength to load coefficients
+            subdir='sellmeier'
+        )
 
     @property
     def reference(self) -> str:
@@ -57,7 +61,7 @@ class Sellmeier():
         """
         return self.sellmeier_coefficients['sellmeier']['reference']
 
-    def get_refractive_index(self, wavelength_range: Union[float, Iterable]) -> Union[float, np.ndarray]:
+    def get_refractive_index(self, wavelength_range: Union[float, Iterable]) -> Union[float, numpy.ndarray]:
         """
         Computes the refractive index for the specified wavelength(s) using the Sellmeier equation.
 
@@ -65,10 +69,10 @@ class Sellmeier():
             wavelength_range (Union[float, Iterable]): The wavelength(s) in meters for which to compute the refractive index.
 
         Returns:
-            Union[float, np.ndarray]: The computed refractive index, either as a scalar or a NumPy array.
+            Union[float, numpy.ndarray]: The computed refractive index, either as a scalar or a NumPy array.
         """
-        return_scalar = np.isscalar(wavelength_range)
-        wavelength_array = np.atleast_1d(wavelength_range).astype(float)
+        return_scalar = numpy.isscalar(wavelength_range)
+        wavelength_array = numpy.atleast_1d(wavelength_range).astype(float)
 
         refractive_index = get_material_index(
             material_name=self.material_name,
@@ -78,41 +82,38 @@ class Sellmeier():
 
         return refractive_index.item() if return_scalar else refractive_index
 
-    def plot(self, wavelength_range: Iterable) -> SceneList:
+    def plot(self, wavelength_range: Iterable) -> NoReturn:
         """
         Plots the refractive index as a function of wavelength over a specified range.
 
         Parameters:
             wavelength_range (Iterable): The range of wavelengths to plot, in meters.
-
-        Returns:
-            SceneList: A SceneList object containing the plot.
         """
-        scene = SceneList()
-        ax = scene.append_ax(x_label='Wavelength [m]', y_label='Refractive index')
+        figure, ax = plt.subplots(1, 1)
+        ax.set_xlabel('Wavelength [m]')
+        ax.set_ylabel('Refractive index')
 
         refractive_index = self.get_refractive_index(wavelength_range)
-
-        ax.add_line(x=wavelength_range, y=refractive_index, line_width=2)
-
-        return scene
+        ax.plot(wavelength_range, refractive_index, linewidth=2)
+        plt.show()
 
     def __repr__(self) -> str:
         """
-        Provides a formal string representation of the DataMeasurement object.
+        Provides a formal string representation of the Sellmeier object.
 
         Returns:
             str: Formal representation of the object, showing the material name.
         """
-        return str(self.material_name)
+        return f"Sellmeier(material_name='{self.material_name}')"
 
     def __str__(self) -> str:
         """
-        Provides an informal string representation of the DataMeasurement object.
+        Provides an informal string representation of the Sellmeier object.
 
         Returns:
             str: Informal representation of the object.
         """
-        return self.__repr__()
+        return self.material_name
+
 
-# -
+Material = Sellmeier

{pyoptik-0.7.11 → pyoptik-0.7.16.post0}/PyOptik.egg-info/PKG-INFO

@@ -1,18 +1,33 @@
 Metadata-Version: 2.1
 Name: PyOptik
-Version: 0.7.11
-Summary: A package/library for refractive index values.
-Home-page: https://github.com/MartinPdeS/PyOptik
-Author: Martin Poinsinet de Sivry
-Author-email: Martin.poinsinet.de.sivry@gmail.com
-License: MIT
-Keywords: refractive index
-Platform: unix
-Platform: linux
-Platform: osx
+Version: 0.7.16.post0
+Summary: A package for refractive index values.
+Author-email: Martin Poinsinet de Sivry-Houle <martin.poinsinet.de.sivry@gmail.com>
+License: MIT License
+        
+        Copyright (c) 2020 Martin de Sivry
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Keywords: refracive index,optics
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: Implementation :: CPython
@@ -20,22 +35,14 @@ Classifier: Development Status :: 4 - Beta
 Classifier: Topic :: Scientific/Engineering :: Physics
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Intended Audience :: Science/Research
+Requires-Python: >=3.10
 Description-Content-Type: text/x-rst
 License-File: LICENSE
-Requires-Dist: pydantic==2.6.3
-Requires-Dist: matplotlib==3.8.2
-Requires-Dist: numpy>=1.26.0
-Requires-Dist: requests==2.31.0
-Requires-Dist: pandas==2.1.1
-Requires-Dist: bs4==0.0.1
-Requires-Dist: MPSTools==0.2.3
-Requires-Dist: MPSPlots>=1.4.2
-Provides-Extra: documentation
-Requires-Dist: numpydoc==1.6.0; extra == "documentation"
-Requires-Dist: sphinx>=5.1.1; extra == "documentation"
-Requires-Dist: sphinx-gallery==0.15.0; extra == "documentation"
-Requires-Dist: sphinx-rtd-theme==2.0.0; extra == "documentation"
-Requires-Dist: pydata-sphinx-theme==0.14.1; extra == "documentation"
+Requires-Dist: pydantic>=2.6.3
+Requires-Dist: numpy
+Requires-Dist: scipy
+Requires-Dist: MPSTools
+Requires-Dist: tabulate
 Provides-Extra: testing
 Requires-Dist: pytest>=0.6; extra == "testing"
 Requires-Dist: pytest-cov>=2.0; extra == "testing"
@@ -44,7 +51,12 @@ Requires-Dist: mypy>=0.910; extra == "testing"
 Requires-Dist: flake8>=3.9; extra == "testing"
 Requires-Dist: tox>=3.24; extra == "testing"
 Requires-Dist: coverage==6.5.0; extra == "testing"
-Requires-Dist: PyMieScatt==1.8.1.1; extra == "testing"
+Provides-Extra: documentation
+Requires-Dist: numpydoc==1.6.0; extra == "documentation"
+Requires-Dist: sphinx>=5.1.1; extra == "documentation"
+Requires-Dist: sphinx-gallery==0.15.0; extra == "documentation"
+Requires-Dist: sphinx-rtd-theme==2.0.0; extra == "documentation"
+Requires-Dist: pydata-sphinx-theme==0.14.1; extra == "documentation"
 
 |Logo|