PyOptik 1.1.5.post0__tar.gz → 1.1.6.post0__tar.gz

{pyoptik-1.1.5.post0 → pyoptik-1.1.6.post0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: PyOptik
-Version: 1.1.5.post0
+Version: 1.1.6.post0
 Summary: A package for refractive index values.
 Author-email: Martin Poinsinet de Sivry-Houle <martin.poinsinet.de.sivry@gmail.com>
 License: MIT License
@@ -28,8 +28,10 @@ License: MIT License
 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 :: 3.13
 Classifier: Programming Language :: Python :: Implementation :: CPython
 Classifier: Development Status :: 4 - Beta
 Classifier: Topic :: Scientific/Engineering :: Physics

{pyoptik-1.1.5.post0 → pyoptik-1.1.6.post0}/PyOptik/_version.py

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

{pyoptik-1.1.5.post0 → pyoptik-1.1.6.post0}/PyOptik/sellmeier_class.py

@@ -54,7 +54,7 @@ class SellmeierMaterial(Material):
         # Extract reference
         self.reference = parsed_yaml.get('REFERENCES', None)
 
-    def check_wavelength_range(self, wavelength: float) -> None:
+    def check_wavelength_range(self, lambda_um: float) -> None:
         """
         Checks if a wavelength is within the material's allowable range and raises an error if it is not.
 
@@ -65,10 +65,9 @@ class SellmeierMaterial(Material):
             ValueError: If the wavelength is outside the allowable range.
         """
         if self.wavelength_range is not None:
-            wavelength_um = wavelength * 1e6
             min_value, max_value = self.wavelength_range
-            if not min_value <= wavelength_um <= max_value:
-                warnings.warn(f"Wavelength {wavelength_um} µm is outside the allowable range of {min_value} µm to {max_value} µm. [{self.filename}]")
+            if not min_value <= lambda_um <= max_value:
+                warnings.warn(f"Wavelength {lambda_um} µm is outside the allowable range of {min_value} µm to {max_value} µm. [{self.filename}]")
 
     def compute_refractive_index(self, wavelength: Union[float, numpy.ndarray]) -> Union[float, numpy.ndarray]:
         """
@@ -84,15 +83,17 @@ class SellmeierMaterial(Material):
             ValueError: If the wavelength is outside the specified range or if an unsupported formula type is encountered.
         """
         # Ensure that wavelength is within the allowable range if it's a single value
-        if isinstance(wavelength, float):
-            self.check_wavelength_range(wavelength)
-        else:  # If it's an array, ensure all values are within range
-            for wl in numpy.nditer(wavelength):
-                self.check_wavelength_range(float(wl))
+        wavelength = numpy.asarray(wavelength)
 
         # Convert wavelength to micrometers
         lambda_um = wavelength * 1e6
 
+        if isinstance(wavelength, float):
+            self.check_wavelength_range(lambda_um)
+        else:  # If it's an array, ensure all values are within range
+            for wl in lambda_um:
+                self.check_wavelength_range(float(wl))
+
         # Compute the refractive index based on the formula type
         match self.formula_type:
             case 1:  # Formula 1 computation (standard Sellmeier)
@@ -128,27 +129,29 @@ class SellmeierMaterial(Material):
         return n
 
 
-    def plot(self, wavelength_range: Union[List[float], numpy.ndarray]) -> NoReturn:
+    def plot(self, wavelength: Optional[List[float]] = None) -> NoReturn:
         """
         Plots the refractive index as a function of wavelength over a specified range.
 
         Args:
             wavelength_range (Union[List[float], numpy.ndarray]): The range of wavelengths to plot, in meters.
         """
-        if isinstance(wavelength_range, list):
-            wavelength_range = numpy.array(wavelength_range)
+        if wavelength is None:
+            wavelength = numpy.linspace(*self.wavelength_range, 100) * 1e-6
+
+        wavelength = numpy.asarray(wavelength)
 
-        if wavelength_range.ndim != 1:
-            raise ValueError("wavelength_range must be a 1D array or list of float values.")
+        if wavelength.ndim != 1:
+            raise ValueError("wavelength must be a 1D array or list of float values.")
 
         # Calculate the refractive index over the wavelength range
-        refractive_index = self.compute_refractive_index(wavelength_range)
+        refractive_index = self.compute_refractive_index(wavelength)
 
         # Plotting
         fig, ax = plt.subplots()
         ax.set_xlabel('Wavelength [m]')
         ax.set_ylabel('Refractive Index')
-        ax.plot(wavelength_range, refractive_index.real, linewidth=2, label='Real Part')
+        ax.plot(wavelength, refractive_index.real, linewidth=2, label='Real Part')
         ax.legend()
         ax.grid(True)
         plt.tight_layout()

{pyoptik-1.1.5.post0 → pyoptik-1.1.6.post0}/PyOptik/tabulated_class.py

@@ -1,6 +1,6 @@
 import numpy
 from dataclasses import dataclass, field
-from typing import Optional, Tuple, Union
+from typing import Optional, Tuple, Union, List
 import yaml
 from scipy.interpolate import interp1d
 import warnings
@@ -54,10 +54,9 @@ class TabulatedMaterial(Material):
         Raises:
             ValueError: If the wavelength is outside the tabulated range.
         """
-        if isinstance(wavelength, float):
-            wavelength = numpy.array([wavelength])
+        wavelength = numpy.asarray(wavelength)
 
-        wavelength *= 1e6
+        wavelength_um = wavelength * 1e6
 
         if numpy.any(wavelength < self.wavelength.min()) or numpy.any(wavelength > self.wavelength.max()):
             warnings.warn(f"Wavelength: {wavelength} is outside the tabulated range of {self.wavelength.min()} µm to {self.wavelength.max()} µm. [{self.filename}]")
@@ -65,24 +64,34 @@ class TabulatedMaterial(Material):
         n_interp = interp1d(self.wavelength, self.n_values, kind='cubic', fill_value='extrapolate')
         k_interp = interp1d(self.wavelength, self.k_values, kind='cubic', fill_value='extrapolate')
 
-        return n_interp(wavelength) + 1j * k_interp(wavelength)
+        return n_interp(wavelength_um) + 1j * k_interp(wavelength_um)
 
-    def plot(self) -> None:
+    def plot(self, wavelength: Optional[List[float]] = None) -> None:
         """
         Plots the tabulated refractive index (n) and absorption (k) as a function of wavelength.
         """
+        if wavelength is None:
+            wavelength = self.wavelength
+            index = self.compute_refractive_index(wavelength=self.wavelength)
+            n_values = index.real
+            k_values = index.imag
+        else:
+            wavelength = self.wavelength
+            n_values = self.n_values
+            k_values = self.k_values
+
         import matplotlib.pyplot as plt
 
         fig, ax1 = plt.subplots()
 
         ax1.set_xlabel('Wavelength [µm]')
         ax1.set_ylabel('Refractive Index (n)', color='tab:blue')
-        ax1.plot(self.wavelength, self.n_values, 'o-', color='tab:blue', label='n')
+        ax1.plot(wavelength, n_values, 'o-', color='tab:blue', label='n')
         ax1.tick_params(axis='y', labelcolor='tab:blue')
 
         ax2 = ax1.twinx()  # instantiate a second axes that shares the same x-axis
         ax2.set_ylabel('Absorption (k)', color='tab:red')  # we already handled the x-label with ax1
-        ax2.plot(self.wavelength, self.k_values, 'o-', color='tab:red', label='k')
+        ax2.plot(wavelength, k_values, 'o-', color='tab:red', label='k')
         ax2.tick_params(axis='y', labelcolor='tab:red')
 
         fig.tight_layout()  # to prevent the right y-label from being slightly clipped

{pyoptik-1.1.5.post0 → pyoptik-1.1.6.post0}/PyOptik.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: PyOptik
-Version: 1.1.5.post0
+Version: 1.1.6.post0
 Summary: A package for refractive index values.
 Author-email: Martin Poinsinet de Sivry-Houle <martin.poinsinet.de.sivry@gmail.com>
 License: MIT License
@@ -28,8 +28,10 @@ License: MIT License
 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 :: 3.13
 Classifier: Programming Language :: Python :: Implementation :: CPython
 Classifier: Development Status :: 4 - Beta
 Classifier: Topic :: Scientific/Engineering :: Physics

{pyoptik-1.1.5.post0 → pyoptik-1.1.6.post0}/PyOptik.egg-info/SOURCES.txt

@@ -59,11 +59,11 @@ docs/Makefile
 docs/make.bat
 docs/deprecated/experiment_material.py
 docs/examples/README.rst
-docs/examples/measurements_tio2.py
-docs/examples/measurements_water.py
-docs/examples/sellmeier_bk7.py
-docs/examples/sellmeier_sf5.py
-docs/examples/sellmeier_silica.py
+docs/examples/plot_bk7.py
+docs/examples/plot_sf5.py
+docs/examples/plot_silica.py
+docs/examples/plot_silver.py
+docs/examples/plot_water.py
 docs/images/logo.png
 docs/source/code.rst
 docs/source/conf.py

pyoptik-1.1.5.post0/docs/examples/sellmeier_bk7.py → pyoptik-1.1.6.post0/docs/examples/plot_bk7.py

@@ -2,22 +2,20 @@
 Plot the Refractive Index of Optical Material: BK7
 =====================================================
 
-This module demonstrates the usage of the PyOptik library to calculate and plot the refractive index of the optical material SF5 over a specified range of wavelengths.
+This module demonstrates the usage of the PyOptik library to calculate and plot the refractive index of the optical material BK7 glass over a specified range of wavelengths.
 
 """
 
 import numpy
-from PyOptik import Sellmeier
+from PyOptik import UsualMaterial
 
 # Initialize the material with the Sellmeier model
-material = Sellmeier('BK7')
+material = UsualMaterial.get('BK7')
 
 # Calculate refractive index at specific wavelengths
-RI = material.get_refractive_index(wavelength_range=[1310e-9, 1550e-9])
+RI = material.compute_refractive_index(wavelength=[1310e-9, 1550e-9])
 
 # Display calculated refractive indices at sample wavelengths
-figure = material.plot(
-    wavelength_range=numpy.linspace(300e-9, 3500e-9, 300)
-)
-
-figure.show()
+material.plot(
+    wavelength=numpy.linspace(300e-9, 1500e-9, 300)
+)

pyoptik-1.1.5.post0/docs/examples/sellmeier_sf5.py → pyoptik-1.1.6.post0/docs/examples/plot_sf5.py

@@ -2,22 +2,20 @@
 Plot the Refractive Index of Optical Material: SF5
 ==================================================
 
-This module demonstrates the usage of the PyOptik library to calculate and plot the refractive index of the optical material SF5 over a specified range of wavelengths.
+This module demonstrates the usage of the PyOptik library to calculate and plot the refractive index of the optical material SF5 glass over a specified range of wavelengths.
 
 """
 
 import numpy
-from PyOptik import Sellmeier
+from PyOptik import UsualMaterial
 
 # Initialize the material with the Sellmeier model
-material = Sellmeier('SF5')
+material = UsualMaterial.get('SF5')
 
 # Calculate refractive index at specific wavelengths
-RI = material.get_refractive_index(wavelength_range=[1310e-9, 1550e-9])
+RI = material.compute_refractive_index(wavelength=[1310e-9, 1550e-9])
 
 # Display calculated refractive indices at sample wavelengths
-figure = material.plot(
-    wavelength_range=numpy.linspace(300e-9, 3500e-9, 300)
+material.plot(
+    wavelength=numpy.linspace(400e-9, 1500e-9, 300)
 )
-
-figure.show()

pyoptik-1.1.6.post0/docs/examples/plot_silica.py

@@ -0,0 +1,21 @@
+"""
+Plot the Refractive Index of Optical Material: Silica
+=====================================================
+
+This module demonstrates the usage of the PyOptik library to calculate and plot the refractive index of the optical material Silica over a specified range of wavelengths.
+
+"""
+
+import numpy
+from PyOptik import UsualMaterial
+
+# Initialize the material with the Sellmeier model
+material = UsualMaterial.fused_silica
+
+# Calculate refractive index at specific wavelengths
+RI = material.compute_refractive_index(wavelength=[1310e-9, 1550e-9])
+
+# Display calculated refractive indices at sample wavelengths
+material.plot(
+    wavelength=numpy.linspace(500e-9, 1500e-9, 300)
+)

pyoptik-1.1.5.post0/docs/examples/sellmeier_silica.py → pyoptik-1.1.6.post0/docs/examples/plot_silver.py

@@ -7,17 +7,16 @@ This module demonstrates the usage of the PyOptik library to calculate and plot
 """
 
 import numpy
-from PyOptik import Sellmeier
+from PyOptik import UsualMaterial
 
 # Initialize the material with the Sellmeier model
-material = Sellmeier('silica')
+material = UsualMaterial.silver
 
 # Calculate refractive index at specific wavelengths
-RI = material.get_refractive_index(wavelength_range=[1310e-9, 1550e-9])
+RI = material.compute_refractive_index(wavelength=[1310e-9, 1550e-9])
 
 # Display calculated refractive indices at sample wavelengths
-figure = material.plot(
-    wavelength_range=numpy.linspace(300e-9, 3500e-9, 300)
+material.plot(
+    wavelength=numpy.linspace(300e-9, 1500e-9, 300)
 )
 
-figure.show()

pyoptik-1.1.6.post0/docs/examples/plot_water.py

@@ -0,0 +1,22 @@
+"""
+Plot the Refractive Index of Optical Material: Silica
+=====================================================
+
+This module demonstrates the usage of the PyOptik library to calculate and plot the refractive index of the optical material water over a specified range of wavelengths.
+
+"""
+
+import numpy
+from PyOptik import UsualMaterial
+
+# Initialize the material with the Sellmeier model
+material = UsualMaterial.water
+
+# Calculate refractive index at specific wavelengths
+RI = material.compute_refractive_index(wavelength=[800e-9, 900e-9])
+
+# Display calculated refractive indices at sample wavelengths
+material.plot(
+    wavelength=numpy.linspace(300e-9, 1000e-9, 300)
+)
+

{pyoptik-1.1.5.post0 → pyoptik-1.1.6.post0}/pyproject.toml

@@ -13,8 +13,10 @@ authors = [{ name="Martin Poinsinet de Sivry-Houle", email="martin.poinsinet.de.
 classifiers = [
     'Programming Language :: Python',
     'Programming Language :: Python :: 3',
+    'Programming Language :: Python :: 3.10',
     'Programming Language :: Python :: 3.11',
     'Programming Language :: Python :: 3.12',
+    'Programming Language :: Python :: 3.13',
     'Programming Language :: Python :: Implementation :: CPython',
     'Development Status :: 4 - Beta',
     'Topic :: Scientific/Engineering :: Physics',

{pyoptik-1.1.5.post0 → pyoptik-1.1.6.post0}/tests/test_sellmeier.py

@@ -25,9 +25,8 @@ def test_init_material():
 @patch("matplotlib.pyplot.show")
 def test_material_plot(mock_show, material: str):
     material = Material(material)
-    wavelength_range = [500e-9]
 
-    material.plot(wavelength_range=wavelength_range)
+    material.plot(wavelength=[500e-9])
 
     plt.close()
 

pyoptik-1.1.5.post0/docs/examples/measurements_tio2.py

@@ -1,23 +0,0 @@
-"""
-Plot the Refractive Index of Optical Material: Ti02
-===================================================
-
-This module demonstrates the usage of the PyOptik library to calculate and plot the refractive index of the optical material SF5 over a specified range of wavelengths.
-
-"""
-
-import numpy
-from PyOptik import DataMeasurement
-
-# Initialize the material with the Sellmeier model
-material = DataMeasurement('tio2')
-
-# Calculate refractive index at specific wavelengths
-RI = material.get_refractive_index(wavelength_range=[1310e-9, 1550e-9])
-
-# Display calculated refractive indices at sample wavelengths
-figure = material.plot(
-    wavelength_range=numpy.linspace(10e-9, 3500e-9, 300)
-)
-
-figure.show()

pyoptik-1.1.5.post0/docs/examples/measurements_water.py

@@ -1,23 +0,0 @@
-"""
-Plot the Refractive Index of Optical Material: Water
-====================================================
-
-This module demonstrates the usage of the PyOptik library to calculate and plot the refractive index of the optical material SF5 over a specified range of wavelengths.
-
-"""
-
-import numpy
-from PyOptik import DataMeasurement
-
-# Initialize the material with the Sellmeier model
-material = DataMeasurement('water')
-
-# Calculate refractive index at specific wavelengths
-RI = material.get_refractive_index(wavelength_range=[1310e-9, 1550e-9])
-
-# Display calculated refractive indices at sample wavelengths
-figure = material.plot(
-    wavelength_range=numpy.linspace(300e-9, 3500e-9, 300)
-)
-
-figure.show()