PyOptik 1.10.1__tar.gz → 1.10.6__tar.gz

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

@@ -8,6 +8,9 @@ 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:

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PyOptik
-Version: 1.10.1
+Version: 1.10.6
 Summary: A package for refractive index values.
 Author-email: Martin Poinsinet de Sivry-Houle <martin.poinsinet.de.sivry@gmail.com>
 License: MIT License
@@ -43,7 +43,7 @@ Requires-Dist: numpy
 Requires-Dist: matplotlib~=3.8
 Requires-Dist: requests~=2.31
 Requires-Dist: pyyaml~=6.0
-Requires-Dist: MPSPlots~=1.5.1
+Requires-Dist: MPSPlots>=1.6
 Requires-Dist: tabulate~=0.9
 Provides-Extra: testing
 Requires-Dist: pytest<9.0,>=7.4; extra == "testing"

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

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

pyoptik-1.10.6/PyOptik/utils.py

@@ -0,0 +1,45 @@
+from PyOptik.directories import sellmeier_data_path, tabulated_data_path
+from PyOptik.material_type import MaterialType
+import requests
+import logging
+
+
+logging.basicConfig(
+    level=logging.INFO,
+    format="%(asctime)s %(levelname)s %(message)s",
+)
+
+def download_yml_file(url: str, filename: str, location: MaterialType) -> None:
+    """
+    Downloads a .yml file from a specified URL and saves it locally.
+    """
+    match location:
+        case MaterialType.SELLMEIER:
+            file_path = sellmeier_data_path / f"{filename}.yml"
+        case MaterialType.TABULATED:
+            file_path = tabulated_data_path / f"{filename}.yml"
+        case _:
+            raise ValueError(f"Location [{location}] is invalid, it can be either MaterialType.SELLMEIER or MaterialType.TABULATED")
+
+
+    logging.info(f"Starting download of {url!r} → {file_path!s}")
+    try:
+        response = requests.get(url, timeout=10)
+        logging.info(f"Received response: HTTP {response.status_code}")
+        response.raise_for_status()
+
+        file_path.parent.mkdir(parents=True, exist_ok=True)
+
+        with open(file_path, "wb") as f:
+            f.write(response.content)
+        logging.info(f"File downloaded and saved to {file_path}")
+
+    except requests.exceptions.Timeout as e:
+        logging.error(f"Timeout after 10 s when fetching {url!r}: {e}")
+        raise
+    except requests.exceptions.HTTPError as e:
+        logging.error(f"HTTP error while fetching {url!r}: {e}")
+        raise
+    except Exception as e:
+        logging.error(f"Unexpected error: {e}")
+        raise

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PyOptik
-Version: 1.10.1
+Version: 1.10.6
 Summary: A package for refractive index values.
 Author-email: Martin Poinsinet de Sivry-Houle <martin.poinsinet.de.sivry@gmail.com>
 License: MIT License
@@ -43,7 +43,7 @@ Requires-Dist: numpy
 Requires-Dist: matplotlib~=3.8
 Requires-Dist: requests~=2.31
 Requires-Dist: pyyaml~=6.0
-Requires-Dist: MPSPlots~=1.5.1
+Requires-Dist: MPSPlots>=1.6
 Requires-Dist: tabulate~=0.9
 Provides-Extra: testing
 Requires-Dist: pytest<9.0,>=7.4; extra == "testing"

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

@@ -103,8 +103,8 @@ docs/examples/tabulated/README.rst
 docs/examples/tabulated/plot_sf5.py
 docs/examples/tabulated/plot_silver.py
 docs/examples/utils/README.rst
+docs/examples/utils/__build_library.py
 docs/examples/utils/__download_yml_file.py
-docs/examples/utils/build_library.py
 docs/examples/utils/create_sellmeier_file.py
 docs/examples/utils/create_tabulated_file.py
 docs/images/example_bk7.png

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

@@ -5,7 +5,7 @@ numpy
 matplotlib~=3.8
 requests~=2.31
 pyyaml~=6.0
-MPSPlots~=1.5.1
+MPSPlots>=1.6
 tabulate~=0.9
 
 [dev]

{pyoptik-1.10.1 → pyoptik-1.10.6}/docs/examples/tabulated/plot_silver.py

@@ -9,7 +9,6 @@ This module demonstrates the usage of the PyOptik library to calculate and plot
 # %%
 import numpy
 from PyOptik import MaterialBank
-MaterialBank.build_library('metals')
 
 # Initialize the material with the Sellmeier model
 material = MaterialBank.silver

{pyoptik-1.10.1 → pyoptik-1.10.6}/docs/source/conf.py

@@ -35,7 +35,6 @@ author = 'Martin Poinsinet de Sivry-Houle'
 
 extensions = [
     'sphinx.ext.mathjax',
-    'pyvista.ext.plot_directive',
     'sphinx_gallery.gen_gallery',
     'sphinx.ext.autodoc',
     'sphinx.ext.napoleon',

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

@@ -30,7 +30,7 @@ dependencies = [
     "matplotlib ~=3.8",
     "requests ~=2.31",
     "pyyaml ~=6.0",
-    "MPSPlots ~=1.5.1",
+    "MPSPlots >=1.6",
     "tabulate ~=0.9",
 ]
 

pyoptik-1.10.6/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.1/PyOptik/utils.py

@@ -1,45 +0,0 @@
-import requests
-import logging
-from PyOptik.directories import sellmeier_data_path, tabulated_data_path
-from PyOptik.material_type import MaterialType
-
-def download_yml_file(url: str, filename: str, location: MaterialType) -> None:
-    """
-    Downloads a .yml file from a specified URL and saves it locally.
-
-    Parameters
-    ----------
-    url : str
-        The URL of the .yml file to download.
-    save_path : str
-        The local path where the .yml file should be saved.
-
-    Raises
-    ------
-        HTTPError: If the download fails due to an HTTP error.
-    """
-    match location:
-        case MaterialType.SELLMEIER:
-            file_path = sellmeier_data_path / f"{filename}.yml"
-        case MaterialType.TABULATED:
-            file_path = tabulated_data_path / f"{filename}.yml"
-        case _:
-            raise ValueError(f"Location [{location}] is invalid, it can be either MaterialType.SELLMEIER or MaterialType.TABULATED")
-
-    try:
-        # Send a GET request to the URL
-        response = requests.get(url)
-        response.raise_for_status()  # Raise an error for bad status codes
-
-        # Save the content of the response as a file
-        file_path.parent.mkdir(parents=True, exist_ok=True)  # Create directories if they don't exist
-
-        with open(file_path, 'wb') as file:
-            file.write(response.content)
-
-        logging.info(f"File downloaded and saved to {file_path}")
-
-    except requests.exceptions.HTTPError as http_err:
-        logging.warning(f"HTTP error occurred: {http_err}")
-    except Exception as err:
-        logging.error(f"An error occurred: {err}")

pyoptik-1.10.1/tests/test_utils.py

@@ -1,168 +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):
-    download_yml_file(
-        filename='example_download',
-        url='__invalid_url__.com',
-        location=MaterialType.SELLMEIER
-    )
-
-    assert 'An error occurred' in caplog.text, "Warning was not raised: {caplog.text}"
-
-
-if __name__ == "__main__":
-    pytest.main(["-W error", __file__])