PyOptik 1.10.6__tar.gz → 1.10.7__tar.gz

{pyoptik-1.10.6 → pyoptik-1.10.7}/.github/workflows/deploy_documentation.yml

@@ -8,10 +8,6 @@ on:
   pull_request:
     branches: [ "master" ]
 
-concurrency:
-  group: ${{ github.workflow }}-${{ github.ref }}
-  cancel-in-progress: true
-
 # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
 permissions:
   contents: write

{pyoptik-1.10.6 → pyoptik-1.10.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PyOptik
-Version: 1.10.6
+Version: 1.10.7
 Summary: A package for refractive index values.
 Author-email: Martin Poinsinet de Sivry-Houle <martin.poinsinet.de.sivry@gmail.com>
 License: MIT License
@@ -36,9 +36,7 @@ Classifier: Intended Audience :: Science/Research
 Requires-Python: >=3.10
 Description-Content-Type: text/x-rst
 License-File: LICENSE
-Requires-Dist: flexparser<0.4
 Requires-Dist: pint~=0.24
-Requires-Dist: pydantic~=2.9
 Requires-Dist: numpy
 Requires-Dist: matplotlib~=3.8
 Requires-Dist: requests~=2.31

{pyoptik-1.10.6 → pyoptik-1.10.7}/PyOptik/_version.py

@@ -17,5 +17,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '1.10.6'
-__version_tuple__ = version_tuple = (1, 10, 6)
+__version__ = version = '1.10.7'
+__version_tuple__ = version_tuple = (1, 10, 7)

{pyoptik-1.10.6 → pyoptik-1.10.7}/PyOptik/directories.py

@@ -28,6 +28,7 @@ logo_path = doc_path.joinpath('images/logo.png')
 examples_path = root_path.joinpath('examples')
 
 sellmeier_data_path = root_path.joinpath('data/sellmeier')
+
 tabulated_data_path = root_path.joinpath('data/tabulated')
 
 data_path = root_path.joinpath('data')

{pyoptik-1.10.6 → pyoptik-1.10.7}/PyOptik/material/sellmeier_class.py

@@ -6,19 +6,12 @@ import numpy
 import itertools
 from MPSPlots.styles import mps
 import matplotlib.pyplot as plt
-from pydantic.dataclasses import Field, ConfigDict, dataclass
-from typing import Tuple, Optional, Union
+from typing import Optional, Union
 from PyOptik.units import micrometer, Quantity
 from PyOptik.directories import sellmeier_data_path
 from PyOptik.material.base_class import BaseMaterial
 
 
-config_dict = ConfigDict(
-    arbitrary_types_allowed=True
-)
-
-
-@dataclass(config=config_dict, slots=True, eq=False)
 class SellmeierMaterial(BaseMaterial):
     """
     Class representing a material with Sellmeier coefficients for refractive index computation.
@@ -36,12 +29,24 @@ class SellmeierMaterial(BaseMaterial):
     formula_type : int
         The formula type to use for refractive index calculation.
     """
-    filename: str
+    def __init__(self, filename: str):
+        """
+        Initializes the SellmeierMaterial with a filename.
+
+        Parameters
+        ----------
+
+        filename : str
+            The name of the YAML file containing material properties.
+        """
+        self.filename = filename
+
+        self.coefficients = None
+        self.wavelength_bound = None
+        self.reference = None
+        self.formula_type = None
 
-    coefficients: Optional[numpy.ndarray] = Field(default=None)
-    wavelength_bound: Optional[Tuple[float, float]] = Field(default=None)
-    reference: Optional[str] = Field(default=None)
-    formula_type: Optional[int] = Field(default=None)
+        self._load_coefficients()
 
     def __repr__(self) -> str:
         return self.__str__()
@@ -49,12 +54,6 @@ class SellmeierMaterial(BaseMaterial):
     def __str__(self) -> str:
         return self.filename
 
-    def __post_init__(self) -> None:
-        """
-        Post-initialization method to load coefficients, wavelength range, formula type, and reference from a YAML file.
-        """
-        self._load_coefficients()
-
     def _load_coefficients(self) -> None:
         """
         Loads the Sellmeier coefficients, wavelength range, formula type, and reference from the specified YAML file.

{pyoptik-1.10.6 → pyoptik-1.10.7}/PyOptik/material/tabulated_class.py

@@ -2,7 +2,6 @@
 # -*- coding: utf-8 -*-
 
 import numpy
-from pydantic.dataclasses import dataclass, Field, ConfigDict
 from typing import Optional, Union
 import yaml
 from PyOptik.directories import tabulated_data_path
@@ -12,12 +11,7 @@ import matplotlib.pyplot as plt
 from PyOptik.units import Quantity, micrometer, meter
 
 
-config_dict = ConfigDict(
-    arbitrary_types_allowed=True
-)
 
-
-@dataclass(config=config_dict, slots=True, eq=False)
 class TabulatedMaterial(BaseMaterial):
     """
     Class representing a material with tabulated refractive index (n) and absorption (k) values.
@@ -35,11 +29,27 @@ class TabulatedMaterial(BaseMaterial):
     reference : Optional[str]
         Reference information for the material data.
     """
-    filename: str
-    wavelength: numpy.ndarray = Field(init=False)
-    n_values: numpy.ndarray = Field(init=False)
-    k_values: numpy.ndarray = Field(init=False)
-    reference: Optional[str] = Field(init=False)
+
+    def __init__(self, filename: str):
+        """
+        Initializes the TabulatedMaterial with a filename.
+
+        Parameters
+        ----------
+        filename : str
+            The name of the YAML file containing material properties.
+        """
+        self.filename = filename
+
+        # Initialize attributes
+        self.wavelength_bound = None
+        self.wavelength = None
+        self.n_values = None
+        self.k_values = None
+        self.reference = None
+
+        # Load tabulated data from the YAML file
+        self._load_tabulated_data()
 
     def __repr__(self) -> str:
         return self.__str__()
@@ -47,12 +57,6 @@ class TabulatedMaterial(BaseMaterial):
     def __str__(self) -> str:
         return self.filename
 
-    def __post_init__(self) -> None:
-        """
-        Post-initialization method to load the tabulated data from the YAML file.
-        """
-        self._load_tabulated_data()
-
     def _load_tabulated_data(self) -> None:
         """
         Loads the tabulated refractive index and absorption values from the specified YAML file.

{pyoptik-1.10.6 → pyoptik-1.10.7}/PyOptik/material_bank.py

@@ -13,11 +13,9 @@ from PyOptik.material.sellmeier_class import SellmeierMaterial
 from PyOptik.material.tabulated_class import TabulatedMaterial
 from PyOptik.utils import download_yml_file
 from tabulate import tabulate
-from dataclasses import dataclass
 from PyOptik.material_type import MaterialType
 
 
-@dataclass(frozen=True, slots=True)
 class _MaterialBank():
     """
     A class representing a centralized material bank for common optical materials available in the PyOptik library.

{pyoptik-1.10.6 → pyoptik-1.10.7}/PyOptik.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PyOptik
-Version: 1.10.6
+Version: 1.10.7
 Summary: A package for refractive index values.
 Author-email: Martin Poinsinet de Sivry-Houle <martin.poinsinet.de.sivry@gmail.com>
 License: MIT License
@@ -36,9 +36,7 @@ Classifier: Intended Audience :: Science/Research
 Requires-Python: >=3.10
 Description-Content-Type: text/x-rst
 License-File: LICENSE
-Requires-Dist: flexparser<0.4
 Requires-Dist: pint~=0.24
-Requires-Dist: pydantic~=2.9
 Requires-Dist: numpy
 Requires-Dist: matplotlib~=3.8
 Requires-Dist: requests~=2.31

{pyoptik-1.10.6 → pyoptik-1.10.7}/PyOptik.egg-info/SOURCES.txt

@@ -1,6 +1,5 @@
 .flake8
 .gitignore
-.readthedocs.yml
 LICENSE
 README.rst
 meta.yaml
@@ -119,5 +118,5 @@ docs/source/gallery/index.rst
 tests/__init__.py
 tests/test_sellmeier.py
 tests/test_tabulated.py
-tests/test_usual_material.py
+tests/test_usual_materials.py
 tests/test_utils.py

{pyoptik-1.10.6 → pyoptik-1.10.7}/PyOptik.egg-info/requires.txt

@@ -1,6 +1,4 @@
-flexparser<0.4
 pint~=0.24
-pydantic~=2.9
 numpy
 matplotlib~=3.8
 requests~=2.31

{pyoptik-1.10.6 → pyoptik-1.10.7}/meta.yaml

@@ -23,14 +23,12 @@ requirements:
     - setuptools-scm >=8.0
     - pip
   run:
-    - flexparser <0.4  # This is due to a dataclass inheritance problem coming from the pint package
     - pint ~= 0.24
     - martinpdes::mpsplots
     - pyyaml ~=6.0
     - requests ~=2.31
     - matplotlib ~=3.8
     - numpy
-    - pydantic ~=2.9
     - tabulate ~=0.9
 
 about:

{pyoptik-1.10.6 → pyoptik-1.10.7}/pyproject.toml

@@ -23,9 +23,7 @@ classifiers = [
 keywords = ["refracive index", "optics"]
 
 dependencies = [
-    "flexparser <0.4",  # This is due to a dataclass inheritance problem coming from the pint package
     "pint ~=0.24",
-    "pydantic ~=2.9",
     "numpy",
     "matplotlib ~=3.8",
     "requests ~=2.31",
@@ -72,7 +70,9 @@ minversion = "6.0"
 xfail_strict = true
 log_cli_level = "INFO"
 testpaths = [
-    "tests/*",
+    "tests/test_sellmeier.py",
+    "tests/test_tabulated.py",
+    "tests/test_usual_materials.py",
 ]
 addopts = [
     '-v',

pyoptik-1.10.7/tests/test_utils.py

@@ -0,0 +1,166 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+import pytest
+from PyOptik import MaterialBank, MaterialType
+from PyOptik.utils import download_yml_file
+
+MaterialBank.set_filter(use_sellmeier=True, use_tabulated=True)
+
+
+def test_main():
+    MaterialBank.build_library('minimal', remove_previous=True)
+
+url_water = 'https://refractiveindex.info/database/data/main/H2O/nk/Daimon-19.0C.yml'
+
+def test_download_yml_files():
+    """
+    Test downloading YAML files to different locations. Ensures that files are
+    correctly downloaded from a given URL to the specified directory.
+    """
+    download_yml_file(
+        filename='test_tabulated',
+        url=url_water,
+        location=MaterialType.TABULATED
+    )
+
+    download_yml_file(
+        filename='test_sellmeier',
+        url=url_water,
+        location=MaterialType.SELLMEIER
+    )
+
+
+def test_add_custom():
+    MaterialBank.add_tabulated_to_bank(
+        filename='test_tabulated',
+        url=url_water,
+    )
+
+    MaterialBank.add_sellmeier_to_bank(
+        filename='test_sellmeier',
+        url=url_water,
+    )
+
+
+def test_fail_add_custom():
+    with pytest.raises(ValueError):
+        MaterialBank.add_material_to_bank(
+            filename='test_tabulated',
+            url=url_water,
+            material_type='invalid_location'
+        )
+
+
+def test_build_library():
+    """
+    Test the creation of the default library. Ensures that the default library
+    is built without errors.
+    """
+    pass
+    # MaterialBank.build_library('minimal', remove_previous=True)
+
+
+def test_remove_item():
+    """
+    Test the removal of an element from a library. Ensures that an element can
+    be removed without errors.
+    """
+    with pytest.raises(ValueError):
+        MaterialBank.remove_item(filename='test', location='invalid_location')
+
+    download_yml_file(
+        filename='test_sellmeier',
+        url=url_water,
+        location=MaterialType.SELLMEIER
+    )
+
+    MaterialBank.remove_item(filename='test_sellmeier', location=MaterialType.SELLMEIER)
+
+    download_yml_file(
+        filename='test_tabulated',
+        url=url_water,
+        location=MaterialType.TABULATED
+    )
+
+    MaterialBank.remove_item(filename='test_tabulated', location=MaterialType.TABULATED)
+
+    download_yml_file(
+        filename='test_sellmeier',
+        url=url_water,
+        location=MaterialType.SELLMEIER
+    )
+
+    MaterialBank.clean_data_files(regex='test*', location=MaterialType.SELLMEIER)
+
+    download_yml_file(
+        filename='test_tabulated',
+        url=url_water,
+        location=MaterialType.TABULATED
+    )
+
+    MaterialBank.clean_data_files(regex='test*', location=MaterialType.TABULATED)
+
+
+def test_create_custom_sellmeier_file():
+    """
+    Test the creation of a custom Sellmeier YAML file. Ensures that the file
+    is created with the correct coefficients and formula type.
+    """
+    with pytest.raises(ValueError):
+        MaterialBank.create_sellmeier_file(
+            filename='test_sellmeier_file',
+            coefficients=[0, 1, 2, 3, 4],
+            formula_type=9,
+            wavelength_range=[1, 1.2],
+            comments='Dummy comment',
+            specs='Random specs'
+        )
+
+        MaterialBank.test_sellmeier_file.compute_refractive_index(1.1e-6)
+
+
+def test_fail_with_wrong_formula_type():
+    """
+    Test the creation of a custom Sellmeier YAML file. Ensures that the file
+    is created with the correct coefficients and formula type.
+    """
+    MaterialBank.create_sellmeier_file(
+        filename='test_sellmeier_file',
+        coefficients=[0, 10.6684293, 0.301516485, 0.0030434748, 1.13475115, 1.54133408, 1104],
+        formula_type=2,
+        wavelength_range=[1, 1.2],
+        comments='Dummy comment',
+        specs='Random specs'
+    )
+
+    MaterialBank.test_sellmeier_file.compute_refractive_index(1.1e-6)
+
+
+def test_create_custom_tabulated_file():
+    """
+    Test the creation of a custom tabulated YAML file. Ensures that the file
+    is created with the correct tabulated data, reference, and comments.
+    """
+    MaterialBank.create_tabulated_file(
+        filename="test_tabulated_file",
+        data=[
+            (0.1879, 0.94, 1.337),
+            (0.1916, 0.95, 1.388),
+            (0.1953, 0.97, 1.440)
+        ],
+        reference="Example of tabulated test file",
+        comments="Room temperature"
+    )
+
+
+def test_download_yml_file_http_error_log(caplog):
+    with pytest.raises(ValueError):
+        download_yml_file(
+            filename='example_download',
+            url='__invalid_url__.com',
+            location=MaterialType.SELLMEIER
+        )
+
+if __name__ == "__main__":
+    pytest.main(["-W error", "-s", __file__])

pyoptik-1.10.6/.readthedocs.yml

@@ -1,35 +0,0 @@
-# .readthedocs.yml
-# Read the Docs configuration file
-# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
-
-# Required
-version: 2
-
-submodules:
-  include: all
-  recursive: true
-
-build:
-  os: ubuntu-22.04
-
-
-  tools:
-    python: "3.10"
-  jobs:
-    pre_install:
-      - Xvfb :99 &
-      - export DISPLAY=:99
-      - cd docs && rm -rf source/gallery
-      - sleep 3
-
-python:
-  install:
-    - method: pip
-      path: .
-      extra_requirements:
-        - documentation
-
-sphinx:
-  builder: html
-  configuration: docs/source/conf.py
-  fail_on_warning: false

pyoptik-1.10.6/tests/test_utils.py

@@ -1,166 +0,0 @@
-#!/usr/bin/env python
-# -*- coding: utf-8 -*-
-
-import pytest
-# from PyOptik import MaterialBank, MaterialType
-# from PyOptik.utils import download_yml_file
-
-# MaterialBank.set_filter(use_sellmeier=True, use_tabulated=True)
-
-
-# def test_main():
-#     MaterialBank.build_library('minimal', remove_previous=True)
-
-# url_water = 'https://refractiveindex.info/database/data/main/H2O/nk/Daimon-19.0C.yml'
-
-# def test_download_yml_files():
-#     """
-#     Test downloading YAML files to different locations. Ensures that files are
-#     correctly downloaded from a given URL to the specified directory.
-#     """
-#     download_yml_file(
-#         filename='test_tabulated',
-#         url=url_water,
-#         location=MaterialType.TABULATED
-#     )
-
-#     download_yml_file(
-#         filename='test_sellmeier',
-#         url=url_water,
-#         location=MaterialType.SELLMEIER
-#     )
-
-
-# def test_add_custom():
-#     MaterialBank.add_tabulated_to_bank(
-#         filename='test_tabulated',
-#         url=url_water,
-#     )
-
-#     MaterialBank.add_sellmeier_to_bank(
-#         filename='test_sellmeier',
-#         url=url_water,
-#     )
-
-
-# def test_fail_add_custom():
-#     with pytest.raises(ValueError):
-#         MaterialBank.add_material_to_bank(
-#             filename='test_tabulated',
-#             url=url_water,
-#             material_type='invalid_location'
-#         )
-
-
-# def test_build_library():
-#     """
-#     Test the creation of the default library. Ensures that the default library
-#     is built without errors.
-#     """
-#     pass
-#     # MaterialBank.build_library('minimal', remove_previous=True)
-
-
-# def test_remove_item():
-#     """
-#     Test the removal of an element from a library. Ensures that an element can
-#     be removed without errors.
-#     """
-#     with pytest.raises(ValueError):
-#         MaterialBank.remove_item(filename='test', location='invalid_location')
-
-#     download_yml_file(
-#         filename='test_sellmeier',
-#         url=url_water,
-#         location=MaterialType.SELLMEIER
-#     )
-
-#     MaterialBank.remove_item(filename='test_sellmeier', location=MaterialType.SELLMEIER)
-
-#     download_yml_file(
-#         filename='test_tabulated',
-#         url=url_water,
-#         location=MaterialType.TABULATED
-#     )
-
-#     MaterialBank.remove_item(filename='test_tabulated', location=MaterialType.TABULATED)
-
-#     download_yml_file(
-#         filename='test_sellmeier',
-#         url=url_water,
-#         location=MaterialType.SELLMEIER
-#     )
-
-#     MaterialBank.clean_data_files(regex='test*', location=MaterialType.SELLMEIER)
-
-#     download_yml_file(
-#         filename='test_tabulated',
-#         url=url_water,
-#         location=MaterialType.TABULATED
-#     )
-
-#     MaterialBank.clean_data_files(regex='test*', location=MaterialType.TABULATED)
-
-
-# def test_create_custom_sellmeier_file():
-#     """
-#     Test the creation of a custom Sellmeier YAML file. Ensures that the file
-#     is created with the correct coefficients and formula type.
-#     """
-#     with pytest.raises(ValueError):
-#         MaterialBank.create_sellmeier_file(
-#             filename='test_sellmeier_file',
-#             coefficients=[0, 1, 2, 3, 4],
-#             formula_type=9,
-#             wavelength_range=[1, 1.2],
-#             comments='Dummy comment',
-#             specs='Random specs'
-#         )
-
-#         MaterialBank.test_sellmeier_file.compute_refractive_index(1.1e-6)
-
-
-# def test_fail_with_wrong_formula_type():
-#     """
-#     Test the creation of a custom Sellmeier YAML file. Ensures that the file
-#     is created with the correct coefficients and formula type.
-#     """
-#     MaterialBank.create_sellmeier_file(
-#         filename='test_sellmeier_file',
-#         coefficients=[0, 10.6684293, 0.301516485, 0.0030434748, 1.13475115, 1.54133408, 1104],
-#         formula_type=2,
-#         wavelength_range=[1, 1.2],
-#         comments='Dummy comment',
-#         specs='Random specs'
-#     )
-
-#     MaterialBank.test_sellmeier_file.compute_refractive_index(1.1e-6)
-
-
-# def test_create_custom_tabulated_file():
-#     """
-#     Test the creation of a custom tabulated YAML file. Ensures that the file
-#     is created with the correct tabulated data, reference, and comments.
-#     """
-#     MaterialBank.create_tabulated_file(
-#         filename="test_tabulated_file",
-#         data=[
-#             (0.1879, 0.94, 1.337),
-#             (0.1916, 0.95, 1.388),
-#             (0.1953, 0.97, 1.440)
-#         ],
-#         reference="Example of tabulated test file",
-#         comments="Room temperature"
-#     )
-
-
-# def _test_download_yml_file_http_error_log(caplog):
-#     with pytest.raises(ValueError):
-#         download_yml_file(
-#             filename='example_download',
-#             url='__invalid_url__.com',
-#             location=MaterialType.SELLMEIER
-        # )
-
-if __name__ == "__main__":
-    pytest.main(["-W error", "-s", __file__])