PyOptik 1.10.4__tar.gz → 1.10.6__tar.gz

{pyoptik-1.10.4 → 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.4 → pyoptik-1.10.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PyOptik
-Version: 1.10.4
+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

{pyoptik-1.10.4 → 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.4'
-__version_tuple__ = version_tuple = (1, 10, 4)
+__version__ = version = '1.10.6'
+__version_tuple__ = version_tuple = (1, 10, 6)

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PyOptik
-Version: 1.10.4
+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

{pyoptik-1.10.4 → 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.4 → 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.4 → pyoptik-1.10.6}/meta.yaml

@@ -25,7 +25,7 @@ requirements:
   run:
     - flexparser <0.4  # This is due to a dataclass inheritance problem coming from the pint package
     - pint ~= 0.24
-    - martinpdes::mpsplots >=1.6
+    - martinpdes::mpsplots
     - pyyaml ~=6.0
     - requests ~=2.31
     - matplotlib ~=3.8

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.4/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__])