PyOptik 1.8.4.post0__tar.gz → 1.8.6.post0__tar.gz

{pyoptik-1.8.4.post0 → pyoptik-1.8.6.post0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: PyOptik
-Version: 1.8.4.post0
+Version: 1.8.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
@@ -276,6 +276,10 @@ As of 2024, PyOptik is still under development. If you would like to collaborate
    :alt: PyPi version
    :target: https://pypistats.org/packages/pyoptik
 
+.. |anaconda_download| image:: https://anaconda.org/martinpdes/pyoptik/badges/downloads.svg
+   :alt: Anaconda downloads
+   :target: https://anaconda.org/martinpdes/pyoptik
+
 .. |coverage| image:: https://raw.githubusercontent.com/MartinPdeS/PyOptik/python-coverage-comment-action-data/badge.svg
    :alt: Unittest coverage
    :target: https://htmlpreview.github.io/?https://github.com/MartinPdeS/PyOptik/blob/python-coverage-comment-action-data/htmlcov/index.html
@@ -283,7 +287,3 @@ As of 2024, PyOptik is still under development. If you would like to collaborate
 .. |anaconda| image:: https://anaconda.org/martinpdes/pyoptik/badges/version.svg
    :alt: Anaconda version
    :target: https://anaconda.org/martinpdes/pyoptik
-
-.. |anaconda_download| image:: https://anaconda.org/martinpdes/pyoptik/badges/downloads.svg
-   :alt: Anaconda downloads
-   :target: https://anaconda.org/martinpdes/pyoptik

{pyoptik-1.8.4.post0 → pyoptik-1.8.6.post0}/PyOptik/_version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '1.8.4.post0'
-__version_tuple__ = version_tuple = (1, 8, 4)
+__version__ = version = '1.8.6.post0'
+__version_tuple__ = version_tuple = (1, 8, 6)

{pyoptik-1.8.4.post0 → pyoptik-1.8.6.post0}/PyOptik/material_bank.py

@@ -8,6 +8,7 @@ import yaml
 import logging
 from pathlib import Path
 from typing import List, Union, Optional, Tuple
+from enum import Enum
 from PyOptik.directories import data_path
 from PyOptik.material.sellmeier_class import SellmeierMaterial
 from PyOptik.material.tabulated_class import TabulatedMaterial
@@ -15,6 +16,9 @@ from PyOptik.utils import download_yml_file
 from tabulate import tabulate
 from dataclasses import dataclass
 
+class MaterialType(Enum):
+    SELLMEIER = "sellmeier"
+    TABULATED = "tabulated"
 
 @dataclass(frozen=True, slots=True)
 class _MaterialBank():
@@ -53,9 +57,12 @@ class _MaterialBank():
         If a material is not found in either the Sellmeier or Tabulated material lists.
     """
 
+    only_tabulated: bool = False
+    only_sellmeier: bool = False
+
     def __getattr__(self, material_name: str) -> Union[SellmeierMaterial, TabulatedMaterial]:
         """
-        Retrieve a material by name dynamically at the class level.
+        Retrieve a material by name dynamically at the class level, respecting filter options.
 
         Parameters
         ----------
@@ -69,37 +76,123 @@ class _MaterialBank():
 
         Raises
         ------
-        FileNotFoundError
-            If the material is not found in either the Sellmeier or Tabulated lists.
+        AttributeError
+            If the material is not found in the filtered or unfiltered lists.
         """
-        if material_name in self.sellmeier:
+        # Apply the filtering logic based on class-level attributes
+        if self.only_sellmeier and material_name in self.sellmeier:
             return SellmeierMaterial(filename=material_name)
-
-        if material_name in self.tabulated:
+        elif self.only_tabulated and material_name in self.tabulated:
             return TabulatedMaterial(filename=material_name)
+        elif not self.only_sellmeier and not self.only_tabulated:
+            # If no filter is set, check in both lists
+            if material_name in self.sellmeier:
+                return SellmeierMaterial(filename=material_name)
+            elif material_name in self.tabulated:
+                return TabulatedMaterial(filename=material_name)
 
         raise AttributeError(f"'{self.__class__.__name__}' object has no attribute '{material_name}'")
 
-    def get(self, filename: str) ->  Union[SellmeierMaterial, TabulatedMaterial]:
-        return self.__getattr__(filename)
+    def get(self, material_name: str) -> Union[SellmeierMaterial, TabulatedMaterial]:
+        """
+        Retrieve a material by name, respecting filter options.
 
-    @property
-    def sellmeier(self) -> List[str]:
+        Parameters
+        ----------
+        material_name : str
+            The name of the material to retrieve.
+
+        Returns
+        -------
+        Union[SellmeierMaterial, TabulatedMaterial]
+            An instance of the material if found.
+
+        Raises
+        ------
+        AttributeError
+            If the material is not found in the filtered or unfiltered lists.
+        """
+        return self.__getattr__(material_name)
+
+    @classmethod
+    def set_filter(cls, only_tabulated: bool = False, only_sellmeier: bool = False) -> None:
+        """
+        Set the filter for the MaterialBank.
+
+        Parameters
+        ----------
+        only_tabulated : bool
+            If True, restricts retrieval to tabulated materials only.
+        only_sellmeier : bool
+            If True, restricts retrieval to sellmeier materials only.
+
+        Raises
+        ------
+        ValueError
+            If both only_tabulated and only_sellmeier are set to True.
+        """
+        if only_tabulated and only_sellmeier:
+            raise ValueError("Cannot set both 'only_tabulated' and 'only_sellmeier' to True.")
+
+        cls.only_tabulated = only_tabulated
+        cls.only_sellmeier = only_sellmeier
+
+    def _list_materials(self, material_type: MaterialType) -> List[str]:
+        """
+        Helper method to list materials of a specific type.
+
+        Parameters
+        ----------
+        material_type : MaterialType
+            The type of materials to list (MaterialType.SELLMEIER or MaterialType.TABULATED).
+
+        Returns
+        -------
+        List[str]
+            A list of material names of the specified type.
+        """
+        directory = data_path / material_type.value
         return [
-            os.path.splitext(f)[0] for f in os.listdir(data_path / 'sellmeier') if os.path.isfile(os.path.join(data_path / 'sellmeier', f)) and f.endswith('.yml')
+            os.path.splitext(f)[0] for f in os.listdir(directory) if os.path.isfile(directory / f) and f.endswith('.yml')
         ]
 
+    @property
+    def sellmeier(self) -> List[str]:
+        """
+        List all available Sellmeier materials.
+
+        Returns
+        -------
+        List[str]
+            A list of all Sellmeier material names.
+        """
+        return self._list_materials(MaterialType.SELLMEIER)
+
     @property
     def tabulated(self) -> List[str]:
-        return [
-            os.path.splitext(f)[0] for f in os.listdir(data_path / 'tabulated') if os.path.isfile(os.path.join(data_path / 'tabulated', f)) and f.endswith('.yml')
-        ]
+        """
+        List all available Tabulated materials.
+
+        Returns
+        -------
+        List[str]
+            A list of all Tabulated material names.
+        """
+        return self._list_materials(MaterialType.TABULATED)
 
     @property
     def all(self) -> List[str]:
+        """
+        List all available materials, including both Sellmeier and Tabulated materials.
+
+        Returns
+        -------
+        List[str]
+            A combined list of all Sellmeier and Tabulated material names.
+        """
         return self.sellmeier + self.tabulated
 
-    def print_materials(cls) -> None:
+    def print_available(cls) -> None:
         """
         Prints out all the available Sellmeier and Tabulated materials in a tabulated format.
         """
@@ -121,49 +214,41 @@ class _MaterialBank():
         print(tabulate(table_data, headers=headers, tablefmt="grid"))
 
     @classmethod
-    def add_sellmeier_to_bank(cls, filename: str, url: str) -> None:
+    def add_material_to_bank(cls, filename: str, url: str, material_type: MaterialType) -> None:
         """
-        Add a Sellmeier material to the material bank.
+        Add a material to the material bank.
 
-        Downloads a YAML file containing the Sellmeier material data from a specified URL and stores it
-        in the Sellmeier materials directory.
+        Downloads a YAML file containing the material data from a specified URL and stores it
+        in the specified materials directory.
 
         Parameters
         ----------
         filename : str
-            The name of the file to be saved in the Sellmeier material bank.
+            The name of the file to be saved in the material bank.
         url : str
             The URL from where the material file is downloaded.
+        material_type : MaterialType
+            The type of material (MaterialType.SELLMEIER or MaterialType.TABULATED).
 
         Returns
         -------
         None
         """
-        return download_yml_file(filename=filename, url=url, location=data_path / 'sellmeier')
-
-    @classmethod
-    def add_tabulated_to_bank(cls, filename: str, url: str) -> None:
-        """
-        Add a Tabulated material to the material bank.
+        if material_type not in [MaterialType.SELLMEIER, MaterialType.TABULATED]:
+            raise ValueError("Invalid material type. Please choose MaterialType.SELLMEIER or MaterialType.TABULATED.")
 
-        Downloads a YAML file containing the Tabulated material data from a specified URL and stores it
-        in the Tabulated materials directory.
+        return download_yml_file(filename=filename, url=url, location=data_path / material_type.value)
 
-        Parameters
-        ----------
-        filename : str
-            The name of the file to be saved in the Tabulated material bank.
-        url : str
-            The URL from where the material file is downloaded.
+    @classmethod
+    def add_sellmeier_to_bank(cls, filename: str, url: str) -> None:
+        return cls.add_material_to_bank(filename, url, MaterialType.SELLMEIER)
 
-        Returns
-        -------
-        None
-        """
-        return download_yml_file(filename=filename, url=url, location=data_path / 'tabulated')
+    @classmethod
+    def add_tabulated_to_bank(cls, filename: str, url: str) -> None:
+        return cls.add_material_to_bank(filename, url, MaterialType.TABULATED)
 
     @classmethod
-    def remove_item(cls, filename: str, location: str = 'any') -> None:
+    def remove_item(cls, filename: str, location: Union[str, MaterialType] = 'any') -> None:
         """
         Remove a file associated with a given element name from the specified location.
 
@@ -171,8 +256,8 @@ class _MaterialBank():
         ----------
         filename : str
             The name of the file to remove, without the '.yml' suffix.
-        location : str
-            The location to search for the file, either 'sellmeier', 'tabulated', or 'any' (default is 'any').
+        location : Union[str, MaterialType]
+            The location to search for the file, either 'sellmeier', 'tabulated', 'any', or a MaterialType enum (default is 'any').
 
         Raises
         ------
@@ -181,6 +266,9 @@ class _MaterialBank():
         ValueError
             If an invalid location is provided.
         """
+        if isinstance(location, MaterialType):
+            location = location.value
+
         location = location.lower()
 
         if location not in ['any', 'sellmeier', 'tabulated']:
@@ -196,7 +284,7 @@ class _MaterialBank():
             if tabulated_file.exists():
                 tabulated_file.unlink()
 
-    def clean_data_files(self, regex: str, location: str = 'any') -> None:
+    def clean_data_files(self, regex: str, location: Union[str, MaterialType] = 'any') -> None:
         """
         Remove all files matching the given regex from the specified location.
 
@@ -204,7 +292,7 @@ class _MaterialBank():
         ----------
         regex : str
             The regex pattern to match the filenames (without the '.yml' suffix).
-        location : str
+        location : Union[str, MaterialType]
             The location to search for files, either 'sellmeier', 'tabulated', or 'any' (default is 'any').
 
         Raises
@@ -212,15 +300,17 @@ class _MaterialBank():
         ValueError
             If an invalid location is provided.
         """
-        # Compile the regex pattern
-        pattern = re.compile(regex)
+        if isinstance(location, MaterialType):
+            location = location.value
 
-        # Normalize the location parameter
         location = location.lower()
 
         if location not in ['any', 'sellmeier', 'tabulated']:
             raise ValueError("Invalid location. Please choose 'sellmeier', 'tabulated', or 'any'.")
 
+        # Compile the regex pattern
+        pattern = re.compile(regex)
+
         # Function to remove matching files in a given directory
         def remove_matching_files(directory: Path):
             for file in directory.glob("*.yml"):
@@ -236,7 +326,6 @@ class _MaterialBank():
         if location in ['any', 'tabulated']:
             remove_matching_files(data_path / 'tabulated')
 
-
     def build_library(self, library: Union[str, List[str]] = 'classics', remove_previous: bool = False) -> None:
         """
         Downloads and saves materials data from the specified URLs.
@@ -363,15 +452,11 @@ class _MaterialBank():
         data_str = "\n".join(" ".join(map(str, row)) for row in data)
 
         # Create the data dictionary for YAML
-        yaml_data = {
-            'REFERENCES': reference,
-            'DATA': [
-                {
-                    'type': 'tabulated nk',
-                    'data': data_str,
-                }
-            ]
-        }
+        yaml_data = {}
+        yaml_data['REFERENCES'] = reference
+        yaml_data['DATA'] = [
+            dict(type='tabulated nk', data=data_str)
+        ]
 
         # Add comments if provided
         if comments:
@@ -386,4 +471,4 @@ class _MaterialBank():
 
         logging.info(f"Tabulated nk data saved to {file_path}")
 
-MaterialBank = _MaterialBank()
+MaterialBank = _MaterialBank()

{pyoptik-1.8.4.post0 → pyoptik-1.8.6.post0}/PyOptik.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: PyOptik
-Version: 1.8.4.post0
+Version: 1.8.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
@@ -276,6 +276,10 @@ As of 2024, PyOptik is still under development. If you would like to collaborate
    :alt: PyPi version
    :target: https://pypistats.org/packages/pyoptik
 
+.. |anaconda_download| image:: https://anaconda.org/martinpdes/pyoptik/badges/downloads.svg
+   :alt: Anaconda downloads
+   :target: https://anaconda.org/martinpdes/pyoptik
+
 .. |coverage| image:: https://raw.githubusercontent.com/MartinPdeS/PyOptik/python-coverage-comment-action-data/badge.svg
    :alt: Unittest coverage
    :target: https://htmlpreview.github.io/?https://github.com/MartinPdeS/PyOptik/blob/python-coverage-comment-action-data/htmlcov/index.html
@@ -283,7 +287,3 @@ As of 2024, PyOptik is still under development. If you would like to collaborate
 .. |anaconda| image:: https://anaconda.org/martinpdes/pyoptik/badges/version.svg
    :alt: Anaconda version
    :target: https://anaconda.org/martinpdes/pyoptik
-
-.. |anaconda_download| image:: https://anaconda.org/martinpdes/pyoptik/badges/downloads.svg
-   :alt: Anaconda downloads
-   :target: https://anaconda.org/martinpdes/pyoptik

{pyoptik-1.8.4.post0 → pyoptik-1.8.6.post0}/PyOptik.egg-info/SOURCES.txt

@@ -23,12 +23,12 @@ PyOptik.egg-info/requires.txt
 PyOptik.egg-info/top_level.txt
 PyOptik/data/__init__.py
 PyOptik/data/classics.yml
-PyOptik/data/glasses.yml
+PyOptik/data/dielectrics.yml
 PyOptik/data/metals.yml
 PyOptik/data/minimal.yml
 PyOptik/data/organics.yml
 PyOptik/data/others.yml
-PyOptik/data/plastics.yml
+PyOptik/data/polymers.yml
 PyOptik/data/sellmeier/BAK1.yml
 PyOptik/data/sellmeier/BK7.yml
 PyOptik/data/sellmeier/SF5.yml

pyoptik-1.8.6.post0/development/dev_0.py

@@ -0,0 +1,9 @@
+import numpy
+from PyOptik import MaterialBank
+MaterialBank.build_library('classics')
+MaterialBank.print_available()  # <- this will provide a table of Tabulated and Sellmeier materials name (usually metals are tabulated)
+material = MaterialBank.gold # <- this should be a TabulatedMaterial instance
+
+wavelength = numpy.linspace(300e-9, 500e-9, 100)
+
+ri = material.compute_refractive_index(wavelength)

{pyoptik-1.8.4.post0 → pyoptik-1.8.6.post0}/docs/examples/utils/build_library.py

@@ -27,5 +27,5 @@ from PyOptik import MaterialBank
 MaterialBank.build_library('glasses', remove_previous=True)
 
 # Print all the available materials (Sellmeier and Tabulated)
-MaterialBank.print_materials()
+MaterialBank.print_available()
 

{pyoptik-1.8.4.post0 → pyoptik-1.8.6.post0}/docs/source/gallery/utils/build_library.ipynb

@@ -22,7 +22,7 @@
       },
       "outputs": [],
       "source": [
-        "from PyOptik import MaterialBank\n\n# Build the 'others' material library and remove previously downloaded files\nMaterialBank.build_library('glasses', remove_previous=True)\n\n# Print all the available materials (Sellmeier and Tabulated)\nMaterialBank.print_materials()"
+        "from PyOptik import MaterialBank\n\n# Build the 'others' material library and remove previously downloaded files\nMaterialBank.build_library('glasses', remove_previous=True)\n\n# Print all the available materials (Sellmeier and Tabulated)\nMaterialBank.print_available()"
       ]
     }
   ],

{pyoptik-1.8.4.post0 → pyoptik-1.8.6.post0}/docs/source/gallery/utils/build_library.py

@@ -27,5 +27,5 @@ from PyOptik import MaterialBank
 MaterialBank.build_library('glasses', remove_previous=True)
 
 # Print all the available materials (Sellmeier and Tabulated)
-MaterialBank.print_materials()
+MaterialBank.print_available()
 

pyoptik-1.8.6.post0/docs/source/gallery/utils/build_library.py.md5

@@ -0,0 +1 @@
+42ef02d2687ccf6fb165da8831dbf098

{pyoptik-1.8.4.post0 → pyoptik-1.8.6.post0}/docs/source/gallery/utils/build_library.rst

@@ -50,7 +50,7 @@ Import necessary modules
     MaterialBank.build_library('glasses', remove_previous=True)
 
     # Print all the available materials (Sellmeier and Tabulated)
-    MaterialBank.print_materials()
+    MaterialBank.print_available()
 
 
 
@@ -124,7 +124,7 @@ Import necessary modules
 
 .. rst-class:: sphx-glr-timing
 
-   **Total running time of the script:** (0 minutes 10.767 seconds)
+   **Total running time of the script:** (0 minutes 11.472 seconds)
 
 
 .. _sphx_glr_download_gallery_utils_build_library.py:

{pyoptik-1.8.4.post0 → pyoptik-1.8.6.post0}/docs/source/gallery/utils/sg_execution_times.rst

@@ -6,14 +6,14 @@
 
 Computation times
 =================
-**00:11.893** total execution time for **gallery_utils** files:
+**00:11.472** total execution time for **gallery_utils** files:
 
 +---------------------------------------------------------------------------------------+-----------+--------+
-| :ref:`sphx_glr_gallery_utils_build_library.py` (``build_library.py``)                 | 00:10.767 | 0.0 MB |
+| :ref:`sphx_glr_gallery_utils_build_library.py` (``build_library.py``)                 | 00:11.472 | 0.0 MB |
 +---------------------------------------------------------------------------------------+-----------+--------+
-| :ref:`sphx_glr_gallery_utils_download_yml_file.py` (``download_yml_file.py``)         | 00:00.757 | 0.0 MB |
+| :ref:`sphx_glr_gallery_utils_create_sellmeier_file.py` (``create_sellmeier_file.py``) | 00:00.000 | 0.0 MB |
 +---------------------------------------------------------------------------------------+-----------+--------+
-| :ref:`sphx_glr_gallery_utils_create_sellmeier_file.py` (``create_sellmeier_file.py``) | 00:00.201 | 0.0 MB |
+| :ref:`sphx_glr_gallery_utils_create_tabulated_file.py` (``create_tabulated_file.py``) | 00:00.000 | 0.0 MB |
 +---------------------------------------------------------------------------------------+-----------+--------+
-| :ref:`sphx_glr_gallery_utils_create_tabulated_file.py` (``create_tabulated_file.py``) | 00:00.169 | 0.0 MB |
+| :ref:`sphx_glr_gallery_utils_download_yml_file.py` (``download_yml_file.py``)         | 00:00.000 | 0.0 MB |
 +---------------------------------------------------------------------------------------+-----------+--------+

{pyoptik-1.8.4.post0 → pyoptik-1.8.6.post0}/meta.yaml

@@ -24,6 +24,7 @@ requirements:
     - pip
     - martinpdes::mpsplots
   run:
+    - pint ~= 0.24
     - martinpdes::mpsplots
     - pyyaml ~=6.0
     - requests ~=2.31
@@ -40,14 +41,16 @@ about:
   dev_url: https://github.com/MartinPdeS/PyOptik
   doc_url: https://pyoptik.readthedocs.io
   license_file: LICENSE
-
+  keywords:
+    - optics
+    - refractive index
+    - material
 
 test:
   imports:
     - PyOptik
   requires:
-    - pip
-    - pint
+    - pint ~= 0.24
     - pytest>=0.6
     - pytest-cov>=2.0
     - pytest-json-report==1.5.0

{pyoptik-1.8.4.post0 → pyoptik-1.8.6.post0}/tests/test_usual_material.py

@@ -11,7 +11,7 @@ def test_usual_material(material_name):
     """
     material_instance = getattr(MaterialBank, material_name)
 
-    MaterialBank.print_materials()
+    MaterialBank.print_available()
 
     assert isinstance(material_instance, (SellmeierMaterial, TabulatedMaterial)), f"{material_name} instantiation failed."
 

pyoptik-1.8.4.post0/development/dev_0.py

@@ -1,6 +0,0 @@
-import yaml
-from PyOptik import MaterialBank
-
-MaterialBank.build_library('classics')
-
-

pyoptik-1.8.4.post0/docs/source/gallery/utils/build_library.py.md5

@@ -1 +0,0 @@
-2eb6578c4290b9e3f2469709b19e7c5c

{pyoptik-1.8.4.post0 → pyoptik-1.8.6.post0}/README.rst

@@ -215,6 +215,10 @@ As of 2024, PyOptik is still under development. If you would like to collaborate
    :alt: PyPi version
    :target: https://pypistats.org/packages/pyoptik
 
+.. |anaconda_download| image:: https://anaconda.org/martinpdes/pyoptik/badges/downloads.svg
+   :alt: Anaconda downloads
+   :target: https://anaconda.org/martinpdes/pyoptik
+
 .. |coverage| image:: https://raw.githubusercontent.com/MartinPdeS/PyOptik/python-coverage-comment-action-data/badge.svg
    :alt: Unittest coverage
    :target: https://htmlpreview.github.io/?https://github.com/MartinPdeS/PyOptik/blob/python-coverage-comment-action-data/htmlcov/index.html
@@ -222,7 +226,3 @@ As of 2024, PyOptik is still under development. If you would like to collaborate
 .. |anaconda| image:: https://anaconda.org/martinpdes/pyoptik/badges/version.svg
    :alt: Anaconda version
    :target: https://anaconda.org/martinpdes/pyoptik
-
-.. |anaconda_download| image:: https://anaconda.org/martinpdes/pyoptik/badges/downloads.svg
-   :alt: Anaconda downloads
-   :target: https://anaconda.org/martinpdes/pyoptik