PyOptik 1.10.8__tar.gz → 1.12.0__tar.gz

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

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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PyOptik
-Version: 1.10.8
+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
@@ -25,13 +25,12 @@ License: MIT License
         OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
         SOFTWARE.
         
-Keywords: refracive index,optics
+Keywords: refractive index,optics
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: Implementation :: CPython
 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
@@ -93,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
 ************
@@ -175,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.10.8 → pyoptik-1.12.0}/PyOptik/__init__.py

@@ -13,3 +13,5 @@ from .material import SellmeierMaterial
 from .material import base_class
 
 Material = MaterialBank  # For retro-compatiibility
+
+TIMEOUT = 10 # Default timeout for requests in seconds

{pyoptik-1.10.8 → 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.10.8 → pyoptik-1.12.0}/PyOptik/_version.py

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

pyoptik-1.12.0/PyOptik/data/sellmeier/BK7.yml

@@ -0,0 +1,57 @@
+# this file is part of refractiveindex.info database
+# refractiveindex.info database is in the public domain
+# copyright and related rights waived via CC0 1.0
+
+REFERENCES: |
+    <a href="https://refractiveindex.info/download/data/2017/schott_2017-01-20b.agf">SCHOTT Zemax catalog 2017-01-20b</a> (obtained from <a href="https://www.schott.com/en-us/products/optical-glass-p1000267/downloads/">http://www.schott.com</a>)<br>See also <a href="https://refractiveindex.info/download/data/2017/schott_2017-01-20.pdf">SCHOTT glass data sheets</a>
+COMMENTS: |
+    suitable for precision molding        
+DATA:
+  - type: formula 2
+    wavelength_range: 0.31 2.5
+    coefficients: 0 1.18318503 0.00722141956 0.0871756426 0.0268216805 1.03133701 101.702362
+  - type: tabulated k
+    data: |
+        0.310 3.8602E-06
+        0.320 1.4536E-06
+        0.334 3.3459E-07
+        0.350 8.0850E-08
+        0.365 3.1801E-08
+        0.370 2.4996E-08
+        0.380 1.7054E-08
+        0.390 1.2477E-08
+        0.400 1.0227E-08
+        0.405 9.0558E-09
+        0.420 8.0456E-09
+        0.436 8.3521E-09
+        0.460 7.3395E-09
+        0.500 6.3790E-09
+        0.546 5.2218E-09
+        0.580 5.5469E-09
+        0.620 5.9295E-09
+        0.660 6.3120E-09
+        0.700 6.6946E-09
+        1.060 3.3758E-09
+        1.530 1.0336E-07
+        1.970 5.2286E-07
+        2.325 2.6396E-06
+        2.500 6.1794E-06
+PROPERTIES:
+    nd: 1.5164
+    Vd: 64.06
+    glass_code: 516641.243
+    glass_status: standard
+    density:
+      - value: 2433
+    thermal_expansion:
+      - temperature_range: 243 343
+        value: 5.99e-06
+      - temperature_range: 293 573
+        value: 7.32e-06
+    dPgF: -0.0025
+    resistance:
+        climatic: 1.0
+        stain: 0.0
+        acid: 1.0
+        alkali: 2.3
+        phosphate: 2.3

{pyoptik-1.10.8 → pyoptik-1.12.0}/PyOptik/directories.py

@@ -1,6 +1,14 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
 
+"""Convenience paths used throughout the :mod:`PyOptik` package.
+
+This module exposes commonly referenced directories such as the project
+root, documentation and data folders.  It is imported by other modules to
+construct absolute paths in a centralised manner and therefore simplifies
+file handling across the code base.
+"""
+
 from pathlib import Path
 import PyOptik
 

{pyoptik-1.10.8 → pyoptik-1.12.0}/PyOptik/libraries/classics.yml

@@ -13,10 +13,11 @@ sellmeier:
   - argon
   - air
   - water
+  - acetone
+  - BK7
 
 tabulated:
   - silicon
-  - BK7
   - silver
   - aluminium
   - gold
@@ -25,4 +26,5 @@ tabulated:
   - iron
   - sodium
   - nickel
-  - zinc
+  - zinc
+  - polyetylene

{pyoptik-1.10.8 → pyoptik-1.12.0}/PyOptik/libraries/dielectrics.yml

@@ -15,7 +15,8 @@ sellmeier:
   - soda_lime_glass
   - crown
   - flint
+  - BK7
 
 tabulated:
-  - BK7
+
   - silicon

{pyoptik-1.10.8 → pyoptik-1.12.0}/PyOptik/libraries/repertoire.yml

@@ -13,6 +13,7 @@ sellmeier:
   lithium_niobate: https://refractiveindex.info/database/data/main/LiNbO3/nk/Zelmon-o.yml
   germanium: https://refractiveindex.info/database/data/main/Ge/nk/Icenogle.yml
 
+  BK7: https://refractiveindex.info/database/data/specs/schott/optical/P-BK7.yml
   soda_lime_glass: https://refractiveindex.info/database/data/glass/misc/soda-lime/nk/Rubin-clear.yml
   crown: https://refractiveindex.info/database/data/specs/schott/optical/K7.yml
   flint: https://refractiveindex.info/database/data/specs/schott/optical/F2.yml
@@ -37,7 +38,6 @@ tabulated:
   pva: https://refractiveindex.info/database/data/organic/(C2H3Cl)n%20-%20polyvinyl%20chloride/nk/Zhang.yml
   polyetylene: https://refractiveindex.info/database/data/organic/(C2H4)n%20-%20polyethylene/nk/Smith.yml
   silicon: https://refractiveindex.info/database/data/main/Si/nk/Aspnes.yml
-  BK7: https://refractiveindex.info/database/data/specs/schott/optical/P-BK7.yml
   silver: https://refractiveindex.info/database/data/main/Ag/nk/Johnson.yml
   aluminium: https://refractiveindex.info/database/data/main/Al/nk/Rakic.yml
   gold: https://refractiveindex.info/database/data/main/Au/nk/Johnson.yml

pyoptik-1.12.0/PyOptik/material/base_class.py

@@ -0,0 +1,137 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+from typing import Callable
+from PyOptik import units
+import numpy
+import warnings
+
+
+class BaseMaterial(object):
+    def __eq__(self, other) -> bool:
+        if not isinstance(other, self.__class__):
+            return False
+
+        if self.filename != other.filename:
+            return False
+
+        return True
+
+    def __str__(self) -> str:
+        """
+        Provides an informal string representation of the Material object.
+
+        Returns
+        -------
+        str
+            Informal representation of the Material object.
+        """
+        return f"Material: {self.filename}"
+
+    def __repr__(self) -> str:
+        """
+        Provides a formal string representation of the Material object, including key attributes.
+
+        Returns
+        -------
+        str
+            Formal representation of the Material object.
+        """
+        return self.__str__()
+
+    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.
+
+        Parameters
+        ----------
+        wavelength : Quantity
+            The wavelength to check, in micrometers.
+
+        Raises
+        ------
+        UserWarning
+            If the wavelength is outside the allowable range.
+        """
+        if self.wavelength_bound is not None:
+            min_value, max_value = self.wavelength_bound
+
+            if numpy.any((wavelength < min_value) | (wavelength > max_value)):
+                warnings.warn(
+                    f"Wavelength range goes from {wavelength.min().to_compact()} to {wavelength.max().to_compact()} "
+                    f"which is outside the allowable range of {min_value.to_compact()} to {max_value.to_compact()} µm. "
+                    f"[Material: {self.filename}]"
+                )
+
+    def ensure_units(func) -> Callable:
+        """Decorator ensuring the wavelength argument carries units.
+
+        Parameters
+        ----------
+        func : Callable
+            Function that expects a wavelength :class:`~PyOptik.units.Quantity`.
+
+        Returns
+        -------
+        Callable
+            Wrapped version of ``func`` that accepts numerical wavelengths and
+            converts them to metre-based :class:`~PyOptik.units.Quantity` objects.
+        """
+        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
+
+            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.10.8 → 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.10.8 → 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
 
 
 
@@ -74,6 +74,7 @@ class TabulatedMaterial(BaseMaterial):
             raise FileNotFoundError(f"YAML file {file_path} not found.")
 
         with file_path.with_suffix('.yml').open('r') as file:
+            print(file)
             parsed_yaml = yaml.safe_load(file)
 
         try:
@@ -81,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).
 
@@ -118,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.
 
@@ -134,10 +135,6 @@ class TabulatedMaterial(BaseMaterial):
         ----------
         wavelength : Optional[Quantity]
             The range of wavelengths to plot, in micrometers. If not provided, the entire tabulated wavelength range is used.
-        title : str, optional
-            Title of the plot.
-        grid : bool, optional
-            Whether to show grid lines on the plot.
 
         Raises
         ------
@@ -155,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()
 
@@ -164,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()