PyOptik 1.8.6.post0__tar.gz → 1.8.7.post0__tar.gz

pyoptik-1.8.7.post0/.flake8

@@ -0,0 +1,11 @@
+[flake8]
+max-line-length = 300
+exclude =
+    .git
+    docs/build
+    docs/source/gallery
+    development
+
+count = true
+per-file-ignores =
+    __init__.py: F403, F401

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: PyOptik
-Version: 1.8.6.post0
+Version: 1.8.7.post0
 Summary: A package for refractive index values.
 Author-email: Martin Poinsinet de Sivry-Houle <martin.poinsinet.de.sivry@gmail.com>
 License: MIT License
@@ -45,13 +45,11 @@ Requires-Dist: pyyaml~=6.0
 Requires-Dist: MPSPlots~=1.5.1
 Requires-Dist: tabulate~=0.9
 Provides-Extra: testing
-Requires-Dist: pytest>=0.6; extra == "testing"
-Requires-Dist: pytest-cov>=2.0; extra == "testing"
-Requires-Dist: pytest-json-report==1.5.0; extra == "testing"
-Requires-Dist: mypy>=0.910; extra == "testing"
-Requires-Dist: flake8>=3.9; extra == "testing"
-Requires-Dist: tox>=3.24; extra == "testing"
-Requires-Dist: coverage==6.5.0; extra == "testing"
+Requires-Dist: pytest<9.0,>=7.4; extra == "testing"
+Requires-Dist: pytest-cov<6,>=2; extra == "testing"
+Requires-Dist: pytest-json-report~=1.5; extra == "testing"
+Requires-Dist: flake8==7.1.1; extra == "testing"
+Requires-Dist: coverage~=7.6; extra == "testing"
 Provides-Extra: documentation
 Requires-Dist: numpydoc==1.6.0; extra == "documentation"
 Requires-Dist: sphinx>=5.1.1; extra == "documentation"

{pyoptik-1.8.6.post0 → pyoptik-1.8.7.post0}/PyOptik/__main__.py

@@ -4,4 +4,4 @@ import logging
 
 if __name__ == '__main__':
     logging.info('Building material library')
-    MaterialBank.build_library('classics')
+    MaterialBank.build_library('classics')

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

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

{pyoptik-1.8.6.post0 → pyoptik-1.8.7.post0}/PyOptik/directories.py

@@ -32,6 +32,8 @@ tabulated_data_path = root_path.joinpath('data/tabulated')
 
 data_path = root_path.joinpath('data')
 
+libraries_path = root_path.joinpath('libraries')
+
 
 if __name__ == '__main__':
     for path_name in __all__:

{pyoptik-1.8.6.post0 → pyoptik-1.8.7.post0}/PyOptik/material/base_class.py

@@ -6,6 +6,7 @@ from PyOptik.units import Quantity, meter
 import numpy
 import warnings
 
+
 class BaseMaterial:
     def __str__(self) -> str:
         """

{pyoptik-1.8.6.post0 → pyoptik-1.8.7.post0}/PyOptik/material/tabulated_class.py

@@ -72,7 +72,6 @@ class TabulatedMaterial(BaseMaterial):
         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
 
         # Extract reference
@@ -161,4 +160,4 @@ class TabulatedMaterial(BaseMaterial):
             f"\nTabulatedMaterial: '{self.filename}',\n"
             f"wavelength_range: [{self.wavelength.min()} µm, {self.wavelength.max()} µm],\n"
             f"reference: '{self.reference}')"
-        )
+        )

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

@@ -9,17 +9,19 @@ 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.directories import data_path, libraries_path
 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
 
+
 class MaterialType(Enum):
     SELLMEIER = "sellmeier"
     TABULATED = "tabulated"
 
+
 @dataclass(frozen=True, slots=True)
 class _MaterialBank():
     """
@@ -45,7 +47,7 @@ class _MaterialBank():
 
     To add a new material to the Sellmeier bank:
 
-    >>> material.add_sellmeier_to_bank("new_material.yml", "http://example.com/material.yml")
+    >>> material.add_sellmeier_to_bank("new_material.yml", "https://refractiveindex.info/database/data-nk/main/SiO2/Malitson.yml")
 
     To remove a material from the bank:
 
@@ -337,7 +339,7 @@ class _MaterialBank():
         remove_previous : bool
             If True, removes existing files before downloading new ones.
         """
-        AVAILABLE_LIBRARIES = {'classics', 'glasses', 'metals', 'organics', 'others', 'minimal'}
+        AVAILABLE_LIBRARIES = [os.path.splitext(f)[0] for f in os.listdir(libraries_path) if f.endswith('.yml')]
 
         libraries_to_download = AVAILABLE_LIBRARIES if library == 'all' else set(numpy.atleast_1d(library))
 
@@ -346,12 +348,12 @@ class _MaterialBank():
 
         # Remove previous files if the flag is set
         if remove_previous:
-            logging.info(f"Removing previous files from the library.")
+            logging.info("Removing previous files from the library.")
             self.clean_data_files(regex=".*", location="sellmeier")  # Remove all sellmeier files
             self.clean_data_files(regex=".*", location="tabulated")  # Remove all tabulated files
 
         for lib in libraries_to_download:
-            file_path = data_path / lib
+            file_path = libraries_path / lib
             with open(file_path.with_suffix('.yml'), 'r') as file:
                 data_dict = yaml.safe_load(file)
 
@@ -366,14 +368,14 @@ class _MaterialBank():
                     download_yml_file(url=url, filename=element_name, location=data_path / 'tabulated')
 
     def create_sellmeier_file(
-        self,
-        filename: str,
-        formula_type: int,
-        coefficients: List[float],
-        wavelength_range: Optional[Tuple[float, float]] = None,
-        reference: Optional[str] = None,
-        comments: Optional[str] = None,
-        specs: Optional[dict] = None) -> None:
+            self,
+            filename: str,
+            formula_type: int,
+            coefficients: List[float],
+            wavelength_range: Optional[Tuple[float, float]] = None,
+            reference: Optional[str] = None,
+            comments: Optional[str] = None,
+            specs: Optional[dict] = None) -> None:
         """
         Creates a YAML file with custom Sellmeier coefficients in the correct format.
 
@@ -427,11 +429,11 @@ class _MaterialBank():
         logging.info(f"Sellmeier data saved to {file_path}")
 
     def create_tabulated_file(
-        self,
-        filename: str,
-        data: List[Tuple[float, float, float]],
-        reference: Optional[str] = None,
-        comments: Optional[str] = None) -> None:
+            self,
+            filename: str,
+            data: List[Tuple[float, float, float]],
+            reference: Optional[str] = None,
+            comments: Optional[str] = None) -> None:
         """
         Creates a YAML file with tabulated nk data in the correct format.
 
@@ -471,4 +473,5 @@ class _MaterialBank():
 
         logging.info(f"Tabulated nk data saved to {file_path}")
 
+
 MaterialBank = _MaterialBank()

{pyoptik-1.8.6.post0 → pyoptik-1.8.7.post0}/PyOptik/units.py

@@ -53,9 +53,4 @@ def initialize_registry(ureg: Optional[pint.UnitRegistry] = None) -> None:
     globals()['ureg'] = ureg
 
 
-
 initialize_registry(ureg)
-
-
-
-

{pyoptik-1.8.6.post0 → pyoptik-1.8.7.post0}/PyOptik/utils.py

@@ -34,5 +34,3 @@ def download_yml_file(url: str, filename: str, location: str) -> None:
         print(f"HTTP error occurred: {http_err}")
     except Exception as err:
         print(f"An error occurred: {err}")
-
-

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: PyOptik
-Version: 1.8.6.post0
+Version: 1.8.7.post0
 Summary: A package for refractive index values.
 Author-email: Martin Poinsinet de Sivry-Houle <martin.poinsinet.de.sivry@gmail.com>
 License: MIT License
@@ -45,13 +45,11 @@ Requires-Dist: pyyaml~=6.0
 Requires-Dist: MPSPlots~=1.5.1
 Requires-Dist: tabulate~=0.9
 Provides-Extra: testing
-Requires-Dist: pytest>=0.6; extra == "testing"
-Requires-Dist: pytest-cov>=2.0; extra == "testing"
-Requires-Dist: pytest-json-report==1.5.0; extra == "testing"
-Requires-Dist: mypy>=0.910; extra == "testing"
-Requires-Dist: flake8>=3.9; extra == "testing"
-Requires-Dist: tox>=3.24; extra == "testing"
-Requires-Dist: coverage==6.5.0; extra == "testing"
+Requires-Dist: pytest<9.0,>=7.4; extra == "testing"
+Requires-Dist: pytest-cov<6,>=2; extra == "testing"
+Requires-Dist: pytest-json-report~=1.5; extra == "testing"
+Requires-Dist: flake8==7.1.1; extra == "testing"
+Requires-Dist: coverage~=7.6; extra == "testing"
 Provides-Extra: documentation
 Requires-Dist: numpydoc==1.6.0; extra == "documentation"
 Requires-Dist: sphinx>=5.1.1; extra == "documentation"

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

@@ -1,3 +1,4 @@
+.flake8
 .gitignore
 .readthedocs.yml
 LICENSE
@@ -22,13 +23,6 @@ PyOptik.egg-info/dependency_links.txt
 PyOptik.egg-info/requires.txt
 PyOptik.egg-info/top_level.txt
 PyOptik/data/__init__.py
-PyOptik/data/classics.yml
-PyOptik/data/dielectrics.yml
-PyOptik/data/metals.yml
-PyOptik/data/minimal.yml
-PyOptik/data/organics.yml
-PyOptik/data/others.yml
-PyOptik/data/polymers.yml
 PyOptik/data/sellmeier/BAK1.yml
 PyOptik/data/sellmeier/BK7.yml
 PyOptik/data/sellmeier/SF5.yml
@@ -53,6 +47,14 @@ PyOptik/data/tabulated/nickel.yml
 PyOptik/data/tabulated/silver.yml
 PyOptik/data/tabulated/sodium.yml
 PyOptik/data/tabulated/zinc.yml
+PyOptik/libraries/__init__.py
+PyOptik/libraries/classics.yml
+PyOptik/libraries/dielectrics.yml
+PyOptik/libraries/metals.yml
+PyOptik/libraries/minimal.yml
+PyOptik/libraries/organics.yml
+PyOptik/libraries/others.yml
+PyOptik/libraries/polymers.yml
 PyOptik/material/__init__.py
 PyOptik/material/base_class.py
 PyOptik/material/sellmeier_class.py

{pyoptik-1.8.6.post0 → pyoptik-1.8.7.post0}/PyOptik.egg-info/requires.txt

@@ -15,10 +15,8 @@ sphinx-rtd-theme==2.0.0
 pydata-sphinx-theme==0.14.1
 
 [testing]
-pytest>=0.6
-pytest-cov>=2.0
-pytest-json-report==1.5.0
-mypy>=0.910
-flake8>=3.9
-tox>=3.24
-coverage==6.5.0
+pytest<9.0,>=7.4
+pytest-cov<6,>=2
+pytest-json-report~=1.5
+flake8==7.1.1
+coverage~=7.6

{pyoptik-1.8.6.post0/docs/source/gallery → pyoptik-1.8.7.post0/docs/examples}/sellmeier/plot_bk7.py

@@ -20,4 +20,4 @@ RI = material.compute_refractive_index(wavelength=[1310, 1550] * nanometer)
 # Display calculated refractive indices at sample wavelengths
 material.plot(
     wavelength=numpy.linspace(300, 1500, 300) * nanometer
-)
+)

{pyoptik-1.8.6.post0/docs/source/gallery → pyoptik-1.8.7.post0/docs/examples}/sellmeier/plot_water.py

@@ -20,4 +20,3 @@ RI = material.compute_refractive_index(wavelength=[800e-9, 900e-9])
 material.plot(
     wavelength=numpy.linspace(300e-9, 1000e-9, 300)
 )
-

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

@@ -23,9 +23,8 @@ The available libraries are:
 # Import necessary modules
 from PyOptik import MaterialBank
 
-# Build the 'others' material library and remove previously downloaded files
-MaterialBank.build_library('glasses', remove_previous=True)
+# Build the 'classics' material library and remove previously downloaded files
+MaterialBank.build_library('classics', remove_previous=True)
 
 # Print all the available materials (Sellmeier and Tabulated)
 MaterialBank.print_available()
-

{pyoptik-1.8.6.post0/docs/source/gallery → pyoptik-1.8.7.post0/docs/examples}/utils/create_sellmeier_file.py

@@ -8,7 +8,6 @@ This example demonstrates how to create a custom Sellmeier YAML file using the
 
 # %%
 from PyOptik.directories import sellmeier_data_path
-from PyOptik import SellmeierMaterial
 from PyOptik import MaterialBank
 
 # Define the file properties

{pyoptik-1.8.6.post0 → pyoptik-1.8.7.post0}/pyproject.toml

@@ -45,15 +45,14 @@ local_scheme = "no-local-version"
 
 [project.optional-dependencies]
 testing = [
-    "pytest >=0.6",
-    "pytest-cov >=2.0",
-    "pytest-json-report ==1.5.0",
-    "mypy >=0.910",
-    "flake8 >=3.9",
-    "tox >=3.24",
-    "coverage ==6.5.0"
+    "pytest >=7.4,<9.0",
+    "pytest-cov >=2,<6",
+    "pytest-json-report ~=1.5",
+    "flake8 ==7.1.1",
+    "coverage ~=7.6"
 ]
 
+
 documentation = [
     "numpydoc ==1.6.0",
     "sphinx >=5.1.1",

{pyoptik-1.8.6.post0 → pyoptik-1.8.7.post0}/tests/test_sellmeier.py

@@ -9,7 +9,7 @@ from PyOptik import MaterialBank
 import matplotlib.pyplot as plt
 from PyOptik.units import meter, micrometer, Quantity
 
-MaterialBank.build_library('minimal', remove_previous=True)
+#  MaterialBank.build_library('minimal', remove_previous=True)
 
 material_list = MaterialBank.sellmeier
 
@@ -115,7 +115,8 @@ def test_compute_refractive_index():
 def test_invalid_formula_type():
     """Test handling of unsupported material types."""
     with pytest.raises(FileNotFoundError):
-        material = Material('invalid_material')
+        Material('invalid_material')
+
 
 @pytest.mark.parametrize('material', material_list, ids=material_list)
 @patch("matplotlib.pyplot.show")

{pyoptik-1.8.6.post0 → pyoptik-1.8.7.post0}/tests/test_tabulated.py

@@ -9,10 +9,12 @@ from PyOptik.units import Quantity, micrometer, meter
 import matplotlib.pyplot as plt
 from PyOptik import MaterialBank
 
-MaterialBank.build_library('minimal', remove_previous=True)
+
+#  MaterialBank.build_library('minimal', remove_previous=True)
 
 material_list = MaterialBank.tabulated
 
+
 def test_init_material():
     """Test initialization of TabulatedMaterial."""
     material = TabulatedMaterial('zinc')

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

@@ -2,7 +2,9 @@ import pytest
 from PyOptik import MaterialBank
 from PyOptik.material import SellmeierMaterial, TabulatedMaterial
 
-MaterialBank.build_library('minimal', remove_previous=True)
+
+#  MaterialBank.build_library('minimal', remove_previous=True)
+
 
 @pytest.mark.parametrize('material_name', MaterialBank.all, ids=lambda name: f'{name}')
 def test_usual_material(material_name):
@@ -20,5 +22,6 @@ def test_fail_wrong_clean():
     with pytest.raises(ValueError):
         MaterialBank.clean_data_files(regex='test*', location='invalid')
 
+
 if __name__ == "__main__":
     pytest.main(["-W error", __file__])

{pyoptik-1.8.6.post0 → pyoptik-1.8.7.post0}/tests/test_utils.py

@@ -6,6 +6,9 @@ from PyOptik import MaterialBank
 from PyOptik.directories import tabulated_data_path, sellmeier_data_path
 from PyOptik.utils import download_yml_file
 
+#  MaterialBank.build_library('minimal', remove_previous=True)
+
+
 def test_main():
     import subprocess
     subprocess.run(["python", "-m", "PyOptik"])
@@ -28,6 +31,7 @@ def test_download_yml_files():
         location=sellmeier_data_path
     )
 
+
 def test_add_custom():
     MaterialBank.add_tabulated_to_bank(
         filename='test_tabulated',
@@ -39,6 +43,7 @@ def test_add_custom():
         url='https://refractiveindex.info/database/data-nk/main/H2O/Daimon-19.0C.yml',
     )
 
+
 def test_build_library():
     """
     Test the creation of the default library. Ensures that the default library
@@ -46,6 +51,7 @@ def test_build_library():
     """
     MaterialBank.build_library('minimal')
 
+
 def test_remove_item():
     """
     Test the removal of an element from a library. Ensures that an element can
@@ -78,7 +84,6 @@ def test_remove_item():
 
     MaterialBank.clean_data_files(regex='test*', location='sellmeier')
 
-
     download_yml_file(
         filename='test_tabulated',
         url='https://refractiveindex.info/database/data-nk/main/H2O/Daimon-19.0C.yml',
@@ -87,6 +92,7 @@ def test_remove_item():
 
     MaterialBank.clean_data_files(regex='test*', location='tabulated')
 
+
 def test_create_custom_sellmeier_file():
     """
     Test the creation of a custom Sellmeier YAML file. Ensures that the file
@@ -104,6 +110,7 @@ def test_create_custom_sellmeier_file():
 
         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
@@ -120,6 +127,7 @@ def test_fail_with_wrong_formula_type():
 
     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
@@ -136,5 +144,6 @@ def test_create_custom_tabulated_file():
         comments="Room temperature"
     )
 
+
 if __name__ == "__main__":
     pytest.main(["-W error", __file__])

{pyoptik-1.8.6.post0 → pyoptik-1.8.7.post0}/PyOptik/material/sellmeier_class.py

@@ -18,6 +18,7 @@ config_dict = ConfigDict(
     arbitrary_types_allowed=True
 )
 
+
 @dataclass(config=config_dict, slots=True)
 class SellmeierMaterial(BaseMaterial):
     """
@@ -61,7 +62,6 @@ class SellmeierMaterial(BaseMaterial):
         with file_path.with_suffix('.yml').open('r') as file:
             parsed_yaml = yaml.safe_load(file)
 
-
         # Extract the formula type
         self.formula_type = int(parsed_yaml['DATA'][0]['type'].split()[-1])