PyOptik 1.4.0.post0__tar.gz → 1.4.1.post0__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: PyOptik
-Version: 1.4.0.post0
+Version: 1.4.1.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.0.post0 → pyoptik-1.4.1.post0}/PyOptik/__init__.py

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

pyoptik-1.4.0.post0/PyOptik/download.py → pyoptik-1.4.1.post0/PyOptik/__main__.py

@@ -2,4 +2,5 @@ from PyOptik.utils import build_default_library
 
 
 if __name__ == '__main__':
+    print('Building material library')
     build_default_library()

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

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

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

@@ -1,3 +1,5 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
 
 class Material:
     def __str__(self) -> str:

pyoptik-1.4.1.post0/PyOptik/material.py

@@ -0,0 +1,129 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+from typing import Union
+from PyOptik.sellmeier_class import SellmeierMaterial
+from PyOptik.tabulated_class import TabulatedMaterial
+from PyOptik import data
+
+class staticproperty(property):
+    """
+    A descriptor that mimics the behavior of a @property but for class-level access.
+
+    This allows a method to be accessed like a static property without the need to instantiate the class.
+    """
+    def __get__(self, owner_self, owner_cls):
+        return self.fget()
+
+class UsualMaterial:
+    """
+    A class representing common materials available in the PyOptik library.
+
+    This class provides easy access to a predefined list of materials, either through static properties or
+    a dynamic getter method. Materials are categorized into Sellmeier and Tabulated materials.
+    """
+
+    all_materials = [
+        'silver',
+        'gold',
+        'aluminium',
+        'copper',
+        'zinc',
+        'iron',
+        'argon',
+        'water',
+        'silicon',
+        'BK7',
+        'fused_silica',
+        'germanium',
+        'polystyren'
+    ]
+
+    @staticmethod
+    def get(material_name: str) -> Union[SellmeierMaterial, TabulatedMaterial]:
+        """
+        Retrieve a material by name.
+
+        Args:
+            material_name (str): The name of the material to retrieve.
+
+        Returns:
+            Union[SellmeierMaterial, TabulatedMaterial]: An instance of the material if found.
+
+        Raises:
+            FileNotFoundError: If the material is not found in either the Sellmeier or Tabulated lists.
+        """
+        if material_name in data.sellmeier.material_list:
+            return SellmeierMaterial(material_name)
+
+        if material_name in data.tabulated.material_list:
+            return TabulatedMaterial(material_name)
+
+        raise FileNotFoundError(f'Material: [{material_name}] could not be found.')
+
+    # Static properties for each material
+
+    @staticproperty
+    def silver() -> TabulatedMaterial:
+        """Get the TabulatedMaterial instance for silver."""
+        return TabulatedMaterial('silver')
+
+    @staticproperty
+    def gold() -> TabulatedMaterial:
+        """Get the TabulatedMaterial instance for gold."""
+        return TabulatedMaterial('gold')
+
+    @staticproperty
+    def aluminium() -> TabulatedMaterial:
+        """Get the TabulatedMaterial instance for aluminium."""
+        return TabulatedMaterial('aluminium')
+
+    @staticproperty
+    def copper() -> TabulatedMaterial:
+        """Get the TabulatedMaterial instance for copper."""
+        return TabulatedMaterial('copper')
+
+    @staticproperty
+    def zinc() -> TabulatedMaterial:
+        """Get the TabulatedMaterial instance for zinc."""
+        return TabulatedMaterial('zinc')
+
+    @staticproperty
+    def iron() -> TabulatedMaterial:
+        """Get the TabulatedMaterial instance for iron."""
+        return TabulatedMaterial('iron')
+
+    @staticproperty
+    def polystyren() -> SellmeierMaterial:
+        """Get the SellmeierMaterial instance for polystyren."""
+        return SellmeierMaterial('polystyren')
+
+    @staticproperty
+    def argon() -> SellmeierMaterial:
+        """Get the SellmeierMaterial instance for argon."""
+        return SellmeierMaterial('argon')
+
+    @staticproperty
+    def water() -> SellmeierMaterial:
+        """Get the SellmeierMaterial instance for water."""
+        return SellmeierMaterial('water')
+
+    @staticproperty
+    def silicon() -> SellmeierMaterial:
+        """Get the SellmeierMaterial instance for silicon."""
+        return SellmeierMaterial('silicon')
+
+    @staticproperty
+    def BK7() -> SellmeierMaterial:
+        """Get the SellmeierMaterial instance for BK7."""
+        return SellmeierMaterial('BK7')
+
+    @staticproperty
+    def fused_silica() -> SellmeierMaterial:
+        """Get the SellmeierMaterial instance for fused_silica."""
+        return SellmeierMaterial('fused_silica')
+
+    @staticproperty
+    def germanium() -> SellmeierMaterial:
+        """Get the SellmeierMaterial instance for germanium."""
+        return SellmeierMaterial('germanium')

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

@@ -4,7 +4,7 @@
 from dataclasses import dataclass, field
 import matplotlib.pyplot as plt
 import numpy
-from typing import Tuple, Optional, Union, NoReturn, List
+from typing import Tuple, Optional, Union, List
 import yaml
 from PyOptik.directories import sellmeier_data_path
 import itertools
@@ -30,9 +30,9 @@ class SellmeierMaterial(Material):
         """
         Loads the Sellmeier coefficients, wavelength range, formula type, and reference from the specified YAML file.
         """
-        file_path = sellmeier_data_path / f'{self.filename}.yml'
+        file_path = sellmeier_data_path / f'{self.filename}'
 
-        with open(file_path, 'r') as file:
+        with open(file_path.with_suffix('.yml'), 'r') as file:
             parsed_yaml = yaml.safe_load(file)
 
         # Extract the formula type
@@ -129,7 +129,7 @@ class SellmeierMaterial(Material):
         return n
 
 
-    def plot(self, wavelength: Optional[List[float]] = None) -> NoReturn:
+    def plot(self, wavelength: Optional[List[float]] = None) -> None:
         """
         Plots the refractive index as a function of wavelength over a specified range.
 

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

@@ -30,9 +30,9 @@ class TabulatedMaterial(Material):
         """
         Loads the tabulated refractive index and absorption values from the specified YAML file.
         """
-        file_path = tabulated_data_path / f'{self.filename}.yml'
+        file_path = tabulated_data_path / f'{self.filename}'
 
-        with open(file_path, 'r') as file:
+        with open(file_path.with_suffix('.yml'), 'r') as file:
             parsed_yaml = yaml.safe_load(file)
 
         # Extract data points

{pyoptik-1.4.0.post0 → pyoptik-1.4.1.post0}/PyOptik/utils.py

@@ -1,12 +1,12 @@
 
 import yaml
-from typing import Optional, List, Tuple, NoReturn
+from typing import Optional, List, Tuple
 import requests
 from PyOptik.directories import sellmeier_data_path, tabulated_data_path
 from PyOptik.data.sellmeier.default import default_material as sellmeier_default
 from PyOptik.data.tabulated.default import default_material as tabulated_default
 
-def download_yml_file(url: str, filename: str, location: str) -> NoReturn:
+def download_yml_file(url: str, filename: str, location: str) -> None:
     """
     Downloads a .yml file from a specified URL and saves it locally.
 
@@ -36,7 +36,7 @@ def download_yml_file(url: str, filename: str, location: str) -> NoReturn:
     except Exception as err:
         print(f"An error occurred: {err}")
 
-def build_default_library() -> NoReturn:
+def build_default_library() -> None:
     """
     Downloads and saves the default materials from the specified URLs.
     """
@@ -83,7 +83,7 @@ def create_sellmeier_file(
     wavelength_range: Optional[Tuple[float, float]] = None,
     reference: Optional[str] = None,
     comments: Optional[str] = None,
-    specs: Optional[dict] = None) -> NoReturn:
+    specs: Optional[dict] = None) -> None:
     """
     Creates a YAML file with custom Sellmeier coefficients in the correct format.
 
@@ -131,7 +131,7 @@ def create_tabulated_file(
     filename: str,
     data: List[Tuple[float, float, float]],
     reference: Optional[str] = None,
-    comments: Optional[str] = None) -> NoReturn:
+    comments: Optional[str] = None) -> None:
     """
     Creates a YAML file with tabulated nk data in the correct format.
 

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: PyOptik
-Version: 1.4.0.post0
+Version: 1.4.1.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.0.post0 → pyoptik-1.4.1.post0}/PyOptik.egg-info/SOURCES.txt

@@ -7,10 +7,10 @@ pyproject.toml
 .github/workflows/coverage.yml
 .github/workflows/deploy_workflow.yml
 PyOptik/__init__.py
+PyOptik/__main__.py
 PyOptik/_version.py
 PyOptik/base_class.py
 PyOptik/directories.py
-PyOptik/download.py
 PyOptik/material.py
 PyOptik/sellmeier_class.py
 PyOptik/tabulated_class.py

{pyoptik-1.4.0.post0 → pyoptik-1.4.1.post0}/docs/examples/create_sellmeier_file.py

@@ -22,7 +22,7 @@ create_sellmeier_file(
     formula_type=formula_type,
     wavelength_range=(0.2, 2.0),
     reference="Sample Reference",
-    comments="This is a sample Sellmeier file created for demonstration purposes."
+    comments="This is a sample Sellmeier file created for demonstration purposes. "
 )
 
 print(f"Sellmeier YAML file {filename}.yml has been created in {sellmeier_data_path}")

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

@@ -2,7 +2,7 @@ import pytest
 from PyOptik import UsualMaterial
 from PyOptik.material import SellmeierMaterial, TabulatedMaterial
 
-@pytest.mark.parametrize('material_name', UsualMaterial.all, ids=lambda name: f'Test {name}')
+@pytest.mark.parametrize('material_name', UsualMaterial.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.
@@ -11,7 +11,7 @@ def test_usual_material(material_name):
 
     assert isinstance(material_instance, (SellmeierMaterial, TabulatedMaterial)), f"{material_name} instantiation failed."
 
-@pytest.mark.parametrize('material_name', UsualMaterial.all, ids=lambda name: f'Test {name}')
+@pytest.mark.parametrize('material_name', UsualMaterial.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.

pyoptik-1.4.0.post0/PyOptik/material.py

@@ -1,88 +0,0 @@
-from typing import Union
-from PyOptik.sellmeier_class import SellmeierMaterial
-from PyOptik.tabulated_class import TabulatedMaterial
-from PyOptik import data
-
-class staticproperty(property):
-  def __get__(self, owner_self, owner_cls):
-    return self.fget()
-
-class UsualMaterial:
-    all = [
-        'silver',
-        'gold',
-        'aluminium',
-        'copper',
-        'zinc',
-        'iron',
-        'argon',
-        'water',
-        'silicon',
-        'BK7',
-        'fused_silica',
-        'germanium',
-        'polystyren'
-    ]
-
-    @staticmethod
-    def get(material_name: str) -> Union[SellmeierMaterial, TabulatedMaterial]:
-        if material_name in data.sellmeier.material_list:
-            return SellmeierMaterial(material_name)
-
-        if material_name in data.tabulated.material_list:
-            return TabulatedMaterial(material_name)
-
-        raise FileNotFoundError(f'Material: [{material_name}] could not be found.')
-
-
-    @staticproperty
-    def silver():
-        return TabulatedMaterial('silver')
-
-    @staticproperty
-    def gold():
-        return TabulatedMaterial('gold')
-
-    @staticproperty
-    def aluminium():
-        return TabulatedMaterial('aluminium')
-
-    @staticproperty
-    def copper():
-        return TabulatedMaterial('copper')
-
-    @staticproperty
-    def zinc():
-        return TabulatedMaterial('zinc')
-
-    @staticproperty
-    def iron():
-        return TabulatedMaterial('iron')
-
-    @staticproperty
-    def polystyren():
-        return SellmeierMaterial('polystyren')
-
-    @staticproperty
-    def argon():
-        return SellmeierMaterial('argon')
-
-    @staticproperty
-    def water():
-        return SellmeierMaterial('water')
-
-    @staticproperty
-    def silicon():
-        return SellmeierMaterial('silicon')
-
-    @staticproperty
-    def BK7():
-        return SellmeierMaterial('BK7')
-
-    @staticproperty
-    def fused_silica():
-        return SellmeierMaterial('fused_silica')
-
-    @staticproperty
-    def germanium():
-        return SellmeierMaterial('germanium')