PyOptik 1.4.1.post0__tar.gz → 1.5.0.post0__tar.gz

{pyoptik-1.4.1.post0 → pyoptik-1.5.0.post0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: PyOptik
-Version: 1.4.1.post0
+Version: 1.5.0.post0
 Summary: A package for refractive index values.
 Author-email: Martin Poinsinet de Sivry-Houle <martin.poinsinet.de.sivry@gmail.com>
 License: MIT License

{pyoptik-1.4.1.post0 → pyoptik-1.5.0.post0}/PyOptik/__init__.py

@@ -6,6 +6,6 @@ except ImportError:
 
 
 from .utils import build_default_library
-from .material import UsualMaterial
+from .material import Material
 from .tabulated_class import TabulatedMaterial
 from .sellmeier_class import SellmeierMaterial

{pyoptik-1.4.1.post0 → pyoptik-1.5.0.post0}/PyOptik/_version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '1.4.1.post0'
-__version_tuple__ = version_tuple = (1, 4, 1)
+__version__ = version = '1.5.0.post0'
+__version_tuple__ = version_tuple = (1, 5, 0)

{pyoptik-1.4.1.post0 → pyoptik-1.5.0.post0}/PyOptik/base_class.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
 
-class Material:
+class BaseMaterial:
     def __str__(self) -> str:
         """
         Provides an informal string representation of the Material object.

{pyoptik-1.4.1.post0 → pyoptik-1.5.0.post0}/PyOptik/material.py

@@ -15,7 +15,7 @@ class staticproperty(property):
     def __get__(self, owner_self, owner_cls):
         return self.fget()
 
-class UsualMaterial:
+class Material:
     """
     A class representing common materials available in the PyOptik library.
 

{pyoptik-1.4.1.post0 → pyoptik-1.5.0.post0}/PyOptik/sellmeier_class.py

@@ -9,11 +9,11 @@ import yaml
 from PyOptik.directories import sellmeier_data_path
 import itertools
 import warnings
-from PyOptik.base_class import Material
+from PyOptik.base_class import BaseMaterial
 from MPSPlots.styles import mps
 
 @dataclass
-class SellmeierMaterial(Material):
+class SellmeierMaterial(BaseMaterial):
     filename: str
     coefficients: numpy.ndarray = field(init=False)
     wavelength_range: Optional[Tuple[float, float]] = field(init=False)

{pyoptik-1.4.1.post0 → pyoptik-1.5.0.post0}/PyOptik/tabulated_class.py

@@ -8,12 +8,12 @@ import yaml
 from scipy.interpolate import interp1d
 import warnings
 from PyOptik.directories import tabulated_data_path
-from PyOptik.base_class import Material
+from PyOptik.base_class import BaseMaterial
 from MPSPlots.styles import mps
 import matplotlib.pyplot as plt
 
 @dataclass
-class TabulatedMaterial(Material):
+class TabulatedMaterial(BaseMaterial):
     filename: str
     wavelength: numpy.ndarray = field(init=False)
     n_values: numpy.ndarray = field(init=False)

{pyoptik-1.4.1.post0 → pyoptik-1.5.0.post0}/PyOptik.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: PyOptik
-Version: 1.4.1.post0
+Version: 1.5.0.post0
 Summary: A package for refractive index values.
 Author-email: Martin Poinsinet de Sivry-Houle <martin.poinsinet.de.sivry@gmail.com>
 License: MIT License

{pyoptik-1.4.1.post0/docs/source/gallery → pyoptik-1.5.0.post0/docs/examples}/plot_bk7.py

@@ -7,10 +7,10 @@ This module demonstrates the usage of the PyOptik library to calculate and plot
 """
 
 import numpy
-from PyOptik import UsualMaterial
+from PyOptik import Material
 
 # Initialize the material with the Sellmeier model
-material = UsualMaterial.get('BK7')
+material = Material.get('BK7')
 
 # Calculate refractive index at specific wavelengths
 RI = material.compute_refractive_index(wavelength=[1310e-9, 1550e-9])

{pyoptik-1.4.1.post0/docs/source/gallery → pyoptik-1.5.0.post0/docs/examples}/plot_sf5.py

@@ -7,10 +7,10 @@ This module demonstrates the usage of the PyOptik library to calculate and plot
 """
 
 import numpy
-from PyOptik import UsualMaterial
+from PyOptik import Material
 
 # Initialize the material with the Sellmeier model
-material = UsualMaterial.get('SF5')
+material = Material.get('SF5')
 
 # Calculate refractive index at specific wavelengths
 RI = material.compute_refractive_index(wavelength=[1310e-9, 1550e-9])

{pyoptik-1.4.1.post0/docs/source/gallery → pyoptik-1.5.0.post0/docs/examples}/plot_silica.py

@@ -7,10 +7,10 @@ This module demonstrates the usage of the PyOptik library to calculate and plot
 """
 
 import numpy
-from PyOptik import UsualMaterial
+from PyOptik import Material
 
 # Initialize the material with the Sellmeier model
-material = UsualMaterial.fused_silica
+material = Material.fused_silica
 
 # Calculate refractive index at specific wavelengths
 RI = material.compute_refractive_index(wavelength=[1310e-9, 1550e-9])

{pyoptik-1.4.1.post0/docs/source/gallery → pyoptik-1.5.0.post0/docs/examples}/plot_silver.py

@@ -7,10 +7,10 @@ This module demonstrates the usage of the PyOptik library to calculate and plot
 """
 
 import numpy
-from PyOptik import UsualMaterial
+from PyOptik import Material
 
 # Initialize the material with the Sellmeier model
-material = UsualMaterial.silver
+material = Material.silver
 
 # Calculate refractive index at specific wavelengths
 RI = material.compute_refractive_index(wavelength=[1310e-9, 1550e-9])

{pyoptik-1.4.1.post0/docs/source/gallery → pyoptik-1.5.0.post0/docs/examples}/plot_water.py

@@ -7,10 +7,10 @@ This module demonstrates the usage of the PyOptik library to calculate and plot
 """
 
 import numpy
-from PyOptik import UsualMaterial
+from PyOptik import Material
 
 # Initialize the material with the Sellmeier model
-material = UsualMaterial.water
+material = Material.water
 
 # Calculate refractive index at specific wavelengths
 RI = material.compute_refractive_index(wavelength=[800e-9, 900e-9])

{pyoptik-1.4.1.post0 → pyoptik-1.5.0.post0}/tests/test_usual_material.py

@@ -1,22 +1,22 @@
 import pytest
-from PyOptik import UsualMaterial
+from PyOptik import Material
 from PyOptik.material import SellmeierMaterial, TabulatedMaterial
 
-@pytest.mark.parametrize('material_name', UsualMaterial.all_materials, ids=lambda name: f'Test {name}')
+@pytest.mark.parametrize('material_name', Material.all_materials, ids=lambda name: f'Test {name}')
 def test_usual_material(material_name):
     """
     Test each usual material defined in UsualMaterial to ensure that it can be instantiated without errors.
     """
-    material_instance = getattr(UsualMaterial, material_name)
+    material_instance = getattr(Material, material_name)
 
     assert isinstance(material_instance, (SellmeierMaterial, TabulatedMaterial)), f"{material_name} instantiation failed."
 
-@pytest.mark.parametrize('material_name', UsualMaterial.all_materials, ids=lambda name: f'Test {name}')
+@pytest.mark.parametrize('material_name', Material.all_materials, ids=lambda name: f'Test {name}')
 def test_get_material(material_name):
     """
     Test each usual material defined in UsualMaterial to ensure that it can be instantiated without errors.
     """
-    material_instance = UsualMaterial.get('silver')
+    material_instance = Material.get('silver')
 
     assert isinstance(material_instance, TabulatedMaterial), f"{material_name} instantiation failed."