PyOptik 0.7.15.post0__tar.gz → 0.7.16.post0__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: PyOptik
-Version: 0.7.15.post0
+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
@@ -42,7 +42,6 @@ Requires-Dist: pydantic>=2.6.3
 Requires-Dist: numpy
 Requires-Dist: scipy
 Requires-Dist: MPSTools
-Requires-Dist: MPSPlots>=1.4.5
 Requires-Dist: tabulate
 Provides-Extra: testing
 Requires-Dist: pytest>=0.6; extra == "testing"

{pyoptik-0.7.15.post0 → pyoptik-0.7.16.post0}/PyOptik/_version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '0.7.15.post0'
-__version_tuple__ = version_tuple = (0, 7, 15)
+__version__ = version = '0.7.16.post0'
+__version_tuple__ = version_tuple = (0, 7, 16)

{pyoptik-0.7.15.post0 → 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.15.post0 → 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.15.post0 → 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.15.post0 → pyoptik-0.7.16.post0}/PyOptik.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: PyOptik
-Version: 0.7.15.post0
+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
@@ -42,7 +42,6 @@ Requires-Dist: pydantic>=2.6.3
 Requires-Dist: numpy
 Requires-Dist: scipy
 Requires-Dist: MPSTools
-Requires-Dist: MPSPlots>=1.4.5
 Requires-Dist: tabulate
 Provides-Extra: testing
 Requires-Dist: pytest>=0.6; extra == "testing"

{pyoptik-0.7.15.post0 → pyoptik-0.7.16.post0}/PyOptik.egg-info/requires.txt

@@ -2,7 +2,6 @@ pydantic>=2.6.3
 numpy
 scipy
 MPSTools
-MPSPlots>=1.4.5
 tabulate
 
 [documentation]

{pyoptik-0.7.15.post0 → pyoptik-0.7.16.post0}/docs/source/conf.py

@@ -3,7 +3,6 @@
 
 import sys
 from sphinx_gallery.sorting import FileNameSortKey
-from packaging.version import parse
 from MPSPlots.styles import use_mpsplots_style
 
 import PyOptik

{pyoptik-0.7.15.post0 → pyoptik-0.7.16.post0}/pyproject.toml

@@ -29,7 +29,6 @@ dependencies = [
     "numpy",
     "scipy",
     "MPSTools",
-    "MPSPlots>=1.4.5",
     "tabulate",
 ]
 

{pyoptik-0.7.15.post0 → pyoptik-0.7.16.post0}/tests/test_measurements.py

@@ -17,6 +17,4 @@ def test_material_plot(patch, material_name: str):
 
     figure = material.plot(wavelength_range=wavelength_range)
 
-    figure.show()
-
 # -

{pyoptik-0.7.15.post0 → pyoptik-0.7.16.post0}/tests/test_sellmeier.py

@@ -17,7 +17,5 @@ def test_material_plot(patch, material_name: str):
 
     figure = material.plot(wavelength_range=wavelength_range)
 
-    figure.show()
-
 
 # -