PyOptik 1.11.0__tar.gz → 1.12.0__tar.gz

{pyoptik-1.11.0 → pyoptik-1.12.0}/.gitignore

@@ -6,7 +6,7 @@
 *.a
 .coverage*
 *.pytest_cache
-htmlcov
+htmlcov*
 dist
 build
 *.egg*

{pyoptik-1.11.0 → pyoptik-1.12.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PyOptik
-Version: 1.11.0
+Version: 1.12.0
 Summary: A package for refractive index values.
 Author-email: Martin Poinsinet de Sivry-Houle <martin.poinsinet.de.sivry@gmail.com>
 License: MIT License
@@ -92,6 +92,7 @@ Features
 - **Simulation Ready**: Ideal for light-matter interaction simulations, particularly in optics and photonics.
 - **Simple API**: Easy-to-use API that integrates well with other Python libraries.
 - **Open Source**: Fully open-source.
+- **Group Index and Velocity**: Compute group index and group velocity directly from material objects.
 
 Installation
 ************
@@ -174,6 +175,10 @@ After installing PyOptik and building the material library, you can easily acces
    bk7 = MaterialBank.BK7
    n = bk7.compute_refractive_index(0.55e-6)
    print(f"Refractive index at 0.55 µm: {n}")
+   # Group index and group velocity
+   n_g = bk7.compute_group_index(0.55e-6)
+   v_g = bk7.compute_group_velocity(0.55e-6)
+   print(f"Group index: {n_g:.3f}, group velocity: {v_g:.1f}")
 
 Example
 *******

{pyoptik-1.11.0 → pyoptik-1.12.0}/PyOptik/__main__.py

@@ -4,4 +4,4 @@ import logging
 
 if __name__ == '__main__':
     logging.info('Building material library')
-    MaterialBank.build_library('classics')
+    MaterialBank.build_library('all')

{pyoptik-1.11.0 → pyoptik-1.12.0}/PyOptik/_version.py

@@ -17,5 +17,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '1.11.0'
-__version_tuple__ = version_tuple = (1, 11, 0)
+__version__ = version = '1.12.0'
+__version_tuple__ = version_tuple = (1, 12, 0)

{pyoptik-1.11.0 → pyoptik-1.12.0}/PyOptik/material/base_class.py

@@ -2,12 +2,12 @@
 # -*- coding: utf-8 -*-
 
 from typing import Callable
-from PyOptik.units import Quantity, meter
+from PyOptik import units
 import numpy
 import warnings
 
 
-class BaseMaterial:
+class BaseMaterial(object):
     def __eq__(self, other) -> bool:
         if not isinstance(other, self.__class__):
             return False
@@ -39,7 +39,7 @@ class BaseMaterial:
         """
         return self.__str__()
 
-    def _check_wavelength(self, wavelength: Quantity) -> None:
+    def _check_wavelength(self, wavelength: units.Quantity) -> None:
         """
         Checks if a wavelength is within the material's allowable range and raises a warning if it is not.
 
@@ -77,14 +77,61 @@ class BaseMaterial:
             Wrapped version of ``func`` that accepts numerical wavelengths and
             converts them to metre-based :class:`~PyOptik.units.Quantity` objects.
         """
-        def wrapper(self, wavelength: Quantity = None, *args, **kwargs):
+        def wrapper(self, wavelength: units.Quantity = None, *args, **kwargs):
             if wavelength is None:
                 if self.wavelength_bound is None:
                     raise ValueError('Wavelength must be provided for computation.')
                 wavelength = numpy.linspace(self.wavelength_bound[0].magnitude, self.wavelength_bound[1].magnitude, 100) * self.wavelength_bound.units
 
-            import PyOptik.units
-            if not isinstance(wavelength, PyOptik.units.Quantity):
-                wavelength = wavelength * meter
+            if not isinstance(wavelength, units.Quantity):
+                wavelength = wavelength * units.meter
             return func(self, wavelength, *args, **kwargs)
         return wrapper
+
+    @ensure_units
+    def compute_group_index(self, wavelength: units.Quantity, delta: units.Quantity = 1 * units.nanometer) -> units.Quantity:
+        """
+        Calculate the group refractive index n_g(\u03bb).
+        The group index is defined as n_g(\u03bb) = n(\u03bb) - \u03bb * dn/d\u03bb,
+        where n(\u03bb) is the refractive index and dn/d\u03bb is the derivative of
+        the refractive index with respect to wavelength.
+
+        Parameters
+        ----------
+        wavelength : units.Quantity
+            Wavelength at which to compute the group index, in metres.
+        delta : units.Quantity, optional
+            Small change in wavelength for numerical differentiation, default is 1 nanometer.
+
+        Returns
+        -------
+        units.Quantity
+            Group refractive index at the specified wavelength, in dimensionless units.
+        -------
+        units.Quantity
+            Group refractive index at the specified wavelength, in dimensionless units.
+        """
+        n = self.compute_refractive_index(wavelength)
+        n_plus = self.compute_refractive_index(wavelength + delta)
+        dn_dlambda = (n_plus - n) / delta
+        return n - wavelength * dn_dlambda
+
+    @ensure_units
+    def compute_group_velocity(self, wavelength: units.Quantity) -> units.Quantity:
+        """
+        Calculate the group velocity v_g(\u03bb) = c / n_g(\u03bb),
+        where c is the speed of light in vacuum and n_g(\u03bb) is the group index.
+
+        Parameters
+        ----------
+        wavelength : units.Quantity
+            Wavelength at which to compute the group velocity, in metres.
+
+        Returns
+        -------
+        units.Quantity
+            Group velocity at the specified wavelength, in metres per second.
+        """
+        ng = self.compute_group_index(wavelength)
+        c = 299792458 * units.meter / units.second
+        return c / ng

{pyoptik-1.11.0 → pyoptik-1.12.0}/PyOptik/material/sellmeier_class.py

@@ -7,7 +7,7 @@ import itertools
 from MPSPlots.styles import mps
 import matplotlib.pyplot as plt
 from typing import Optional, Union
-from PyOptik.units import micrometer, Quantity
+from PyOptik import units
 from PyOptik.directories import sellmeier_data_path
 from PyOptik.material.base_class import BaseMaterial
 
@@ -80,7 +80,7 @@ class SellmeierMaterial(BaseMaterial):
         if 'wavelength_range' in parsed_yaml['DATA'][0]:
             data_str = parsed_yaml['DATA'][0]['wavelength_range'].split()
 
-            self.wavelength_bound = numpy.array([float(val) for val in data_str]) * micrometer
+            self.wavelength_bound = numpy.array([float(val) for val in data_str]) * units.micrometer
 
         else:
             self.wavelength_bound = None
@@ -89,18 +89,18 @@ class SellmeierMaterial(BaseMaterial):
         self.reference = parsed_yaml.get('REFERENCES', None)
 
     @BaseMaterial.ensure_units
-    def compute_refractive_index(self, wavelength: Union[Quantity]) -> Union[float, numpy.ndarray]:
+    def compute_refractive_index(self, wavelength: Union[units.Quantity]) -> Union[float, numpy.ndarray]:
         r"""
         Computes the refractive index n(\u03bb) using the appropriate formula (either Formula 1, 2, 5, or 6).
 
         Parameters
         ----------
-        wavelength : Union[Quantity]
+        wavelength : Union[units.Quantity]
             The wavelength \u03bb in meters, can be a single float or a numpy array.
 
         Returns
         -------
-        Union[Quantity]
+        Union[units.Quantity]
             The refractive index n(\u03bb) for the given wavelength or array of wavelengths.
 
         Raises
@@ -120,25 +120,25 @@ class SellmeierMaterial(BaseMaterial):
             case 1:  # Formula 1 computation (standard Sellmeier)
                 n_squared = 1.0
                 for (B, C) in zipped_coefficients:
-                    n_squared += (B * wavelength.to(micrometer).magnitude**2) / (wavelength.to(micrometer).magnitude**2 - C**2)
+                    n_squared += (B * wavelength.to(units.micrometer).magnitude**2) / (wavelength.to(units.micrometer).magnitude**2 - C**2)
 
                 n = numpy.sqrt(n_squared)
 
             case 2:  # Formula 2 computation (extended Sellmeier)
                 n_squared = 1 + self.coefficients[0]
                 for (B, C) in zipped_coefficients:
-                    n_squared += (B * wavelength.to(micrometer).magnitude**2) / (wavelength.to(micrometer).magnitude**2 - C)
+                    n_squared += (B * wavelength.to(units.micrometer).magnitude**2) / (wavelength.to(units.micrometer).magnitude**2 - C)
                 n = numpy.sqrt(n_squared)
 
             case 5:  # Formula 5 computation (extended Sellmeier)
                 n = 1 + self.coefficients[0]
                 for (B, C) in zipped_coefficients:
-                    n += B * wavelength.to(micrometer).magnitude**C
+                    n += B * wavelength.to(units.micrometer).magnitude**C
 
             case 6:
                 n = 1 + self.coefficients[0]
                 for (B, C) in zipped_coefficients:
-                    n = B / (C - wavelength.to(micrometer).magnitude**-2)
+                    n = B / (C - wavelength.to(units.micrometer).magnitude**-2)
 
             case _:
                 raise ValueError(f"Unsupported formula type: {self.formula_type}")
@@ -146,13 +146,13 @@ class SellmeierMaterial(BaseMaterial):
         return n[0] if return_as_scalar else n
 
     @BaseMaterial.ensure_units
-    def plot(self, wavelength: Optional[Quantity] = None) -> None:
+    def plot(self, wavelength: Optional[units.Quantity] = None) -> None:
         """
         Plots the refractive index as a function of wavelength over a specified range.
 
         Parameters
         ----------
-        wavelength : Optional[Quantity]
+        wavelength : Optional[units.Quantity]
             The range of wavelengths to plot, in meters. If not provided, the entire allowable wavelength range is used.
 
         Raises
@@ -174,7 +174,7 @@ class SellmeierMaterial(BaseMaterial):
             xlabel=r'Wavelength [$\mu$m]',
             title=f"Refractive Index vs. Wavelength: [{self.filename}]"
         )
-        ax.plot(wavelength.to(micrometer).magnitude, refractive_index.real, linewidth=2, label='Real Part')
+        ax.plot(wavelength.to(units.micrometer).magnitude, refractive_index.real, linewidth=2, label='Real Part')
         ax.legend()
 
         plt.show()

{pyoptik-1.11.0 → pyoptik-1.12.0}/PyOptik/material/tabulated_class.py

@@ -8,7 +8,7 @@ from PyOptik.directories import tabulated_data_path
 from PyOptik.material.base_class import BaseMaterial
 from MPSPlots.styles import mps
 import matplotlib.pyplot as plt
-from PyOptik.units import Quantity, micrometer, meter
+from PyOptik import units
 
 
 
@@ -82,19 +82,19 @@ class TabulatedMaterial(BaseMaterial):
             data_points = parsed_yaml['DATA'][0]['data'].strip().split('\n')
             data = numpy.array([[float(value) for value in point.split()] for point in data_points])
 
-            self.wavelength = data[:, 0] * micrometer
+            self.wavelength = data[:, 0] * units.micrometer
             self.n_values = data[:, 1]
             self.k_values = data[:, 2]
         except (KeyError, IndexError, ValueError):
             raise ValueError(f"Invalid or missing data in YAML file {file_path}")
 
-        self.wavelength_bound = [self.wavelength.min().magnitude, self.wavelength.max().magnitude] * micrometer
+        self.wavelength_bound = [self.wavelength.min().magnitude, self.wavelength.max().magnitude] * units.micrometer
 
         # Extract reference
         self.reference = parsed_yaml.get('REFERENCES', None)
 
     @BaseMaterial.ensure_units
-    def compute_refractive_index(self, wavelength: Union[float, Quantity]) -> numpy.ndarray:
+    def compute_refractive_index(self, wavelength: Union[float, units.Quantity]) -> numpy.ndarray:
         """
         Interpolates the refractive index (n) and absorption (k) values for the given wavelength(s).
 
@@ -119,15 +119,15 @@ class TabulatedMaterial(BaseMaterial):
 
         self._check_wavelength(wavelength)
 
-        n_interp = numpy.interp(wavelength.to(meter).magnitude, self.wavelength.to(meter).magnitude, self.n_values)
-        k_interp = numpy.interp(wavelength.to(meter).magnitude, self.wavelength.to(meter).magnitude, self.k_values)
+        n_interp = numpy.interp(wavelength.to(units.meter).magnitude, self.wavelength.to(units.meter).magnitude, self.n_values)
+        k_interp = numpy.interp(wavelength.to(units.meter).magnitude, self.wavelength.to(units.meter).magnitude, self.k_values)
 
         index = n_interp + 1j * k_interp
 
         return index[0] if return_as_scalar else index
 
     @BaseMaterial.ensure_units
-    def plot(self, wavelength: Optional[Quantity] = None) -> None:
+    def plot(self, wavelength: Optional[units.Quantity] = None) -> None:
         """
         Plots the tabulated refractive index (n) and absorption (k) as a function of wavelength.
 
@@ -152,7 +152,7 @@ class TabulatedMaterial(BaseMaterial):
             ylabel='Refractive Index (n)',
         )
 
-        ax1.plot(wavelength.to(micrometer).magnitude, n_values, 'o-', color='tab:blue', label='n')
+        ax1.plot(wavelength.to(units.micrometer).magnitude, n_values, 'o-', color='tab:blue', label='n')
 
         ax2 = ax1.twinx()
 
@@ -161,7 +161,7 @@ class TabulatedMaterial(BaseMaterial):
             ylabel='Absorption (k)',
         )
 
-        ax2.plot(wavelength.to(micrometer).magnitude, k_values, 'o-', color='tab:red', label='k')
+        ax2.plot(wavelength.to(units.micrometer).magnitude, k_values, 'o-', color='tab:red', label='k')
 
         plt.show()
 

{pyoptik-1.11.0 → pyoptik-1.12.0}/PyOptik/units.py

@@ -6,7 +6,8 @@ pint.set_application_registry(ureg)
 
 # Define a list of base units to scale
 BASE_UNITS = [
-    'meter'
+    'meter',
+    'second'
 ]
 
 # Define prefixes for scaling units

{pyoptik-1.11.0 → pyoptik-1.12.0}/PyOptik.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PyOptik
-Version: 1.11.0
+Version: 1.12.0
 Summary: A package for refractive index values.
 Author-email: Martin Poinsinet de Sivry-Houle <martin.poinsinet.de.sivry@gmail.com>
 License: MIT License
@@ -92,6 +92,7 @@ Features
 - **Simulation Ready**: Ideal for light-matter interaction simulations, particularly in optics and photonics.
 - **Simple API**: Easy-to-use API that integrates well with other Python libraries.
 - **Open Source**: Fully open-source.
+- **Group Index and Velocity**: Compute group index and group velocity directly from material objects.
 
 Installation
 ************
@@ -174,6 +175,10 @@ After installing PyOptik and building the material library, you can easily acces
    bk7 = MaterialBank.BK7
    n = bk7.compute_refractive_index(0.55e-6)
    print(f"Refractive index at 0.55 µm: {n}")
+   # Group index and group velocity
+   n_g = bk7.compute_group_index(0.55e-6)
+   v_g = bk7.compute_group_velocity(0.55e-6)
+   print(f"Group index: {n_g:.3f}, group velocity: {v_g:.1f}")
 
 Example
 *******

{pyoptik-1.11.0 → pyoptik-1.12.0}/PyOptik.egg-info/SOURCES.txt

@@ -89,6 +89,7 @@ docs/source/_static/thumbnail.png
 docs/source/gallery/index.rst
 tests/__init__.py
 tests/test_base_material_decorator.py
+tests/test_group_properties.py
 tests/test_material_bank_extra.py
 tests/test_sellmeier.py
 tests/test_tabulated.py

{pyoptik-1.11.0 → pyoptik-1.12.0}/README.rst

@@ -33,6 +33,7 @@ Features
 - **Simulation Ready**: Ideal for light-matter interaction simulations, particularly in optics and photonics.
 - **Simple API**: Easy-to-use API that integrates well with other Python libraries.
 - **Open Source**: Fully open-source.
+- **Group Index and Velocity**: Compute group index and group velocity directly from material objects.
 
 Installation
 ************
@@ -115,6 +116,10 @@ After installing PyOptik and building the material library, you can easily acces
    bk7 = MaterialBank.BK7
    n = bk7.compute_refractive_index(0.55e-6)
    print(f"Refractive index at 0.55 µm: {n}")
+   # Group index and group velocity
+   n_g = bk7.compute_group_index(0.55e-6)
+   v_g = bk7.compute_group_velocity(0.55e-6)
+   print(f"Group index: {n_g:.3f}, group velocity: {v_g:.1f}")
 
 Example
 *******

{pyoptik-1.11.0 → pyoptik-1.12.0}/pyproject.toml

@@ -73,6 +73,7 @@ testpaths = [
     "tests/test_tabulated.py",
     "tests/test_usual_materials.py",
     "tests/test_utils.py",
+    "tests/test_group_properties.py",
 ]
 addopts = [
     '-v',

pyoptik-1.12.0/tests/test_group_properties.py

@@ -0,0 +1,27 @@
+import numpy as np
+import pytest
+from PyOptik import MaterialBank
+from PyOptik.units import micrometer, meter, ureg
+
+
+def test_group_index_sellmeier():
+    bk7 = MaterialBank.BK7
+    gi = bk7.compute_group_index(0.8 * micrometer)
+    assert gi.magnitude > 0.0
+
+
+def test_group_velocity_tabulated():
+    si = MaterialBank.silicon
+    gv = si.compute_group_velocity(0.6 * micrometer)
+    c = 299792458 * meter / ureg.second
+    assert gv < c
+
+
+def test_group_index_array():
+    water = MaterialBank.water
+    wavelengths = np.linspace(0.5, 0.6, 3) * micrometer
+    gi = water.compute_group_index(wavelengths)
+    assert gi.shape == wavelengths.shape
+
+if __name__ == "__main__":
+    pytest.main(["-W error", "-s", __file__])