PyOptik 0.7.11__tar.gz

pyoptik-0.7.11/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Martin de Sivry
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

pyoptik-0.7.11/MANIFEST.in

@@ -0,0 +1,19 @@
+graft PyOptik
+
+include MANIFEST.in
+include LICENSE
+include README.rst
+include setup.py
+include setup.cfg
+include pyproject.toml
+graft tests
+
+global-exclude __pycache__
+global-exclude .DS_Store
+
+exclude *.ipynb
+exclude *.txt
+exclude *.yaml
+exclude *.yml
+
+exclude .git*

pyoptik-0.7.11/PKG-INFO

@@ -0,0 +1,105 @@
+Metadata-Version: 2.1
+Name: PyOptik
+Version: 0.7.11
+Summary: A package/library for refractive index values.
+Home-page: https://github.com/MartinPdeS/PyOptik
+Author: Martin Poinsinet de Sivry
+Author-email: Martin.poinsinet.de.sivry@gmail.com
+License: MIT
+Keywords: refractive index
+Platform: unix
+Platform: linux
+Platform: osx
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Development Status :: 4 - Beta
+Classifier: Topic :: Scientific/Engineering :: Physics
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Intended Audience :: Science/Research
+Description-Content-Type: text/x-rst
+License-File: LICENSE
+Requires-Dist: pydantic==2.6.3
+Requires-Dist: matplotlib==3.8.2
+Requires-Dist: numpy>=1.26.0
+Requires-Dist: requests==2.31.0
+Requires-Dist: pandas==2.1.1
+Requires-Dist: bs4==0.0.1
+Requires-Dist: MPSTools==0.2.3
+Requires-Dist: MPSPlots>=1.4.2
+Provides-Extra: documentation
+Requires-Dist: numpydoc==1.6.0; extra == "documentation"
+Requires-Dist: sphinx>=5.1.1; extra == "documentation"
+Requires-Dist: sphinx-gallery==0.15.0; extra == "documentation"
+Requires-Dist: sphinx-rtd-theme==2.0.0; extra == "documentation"
+Requires-Dist: pydata-sphinx-theme==0.14.1; extra == "documentation"
+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: PyMieScatt==1.8.1.1; extra == "testing"
+
+|Logo|
+
+|python|
+|docs|
+|unittest|
+|PyPi|
+|PyPi_download|
+
+PyOptik
+=======
+
+
+
+PyOptik is a tool that can be used to import refractive indexes and extinction
+coefficients for different materials at different wavelengths. This data can then
+be used for different applications like simulating light interaction's with
+particules. All the data comes from RefractiveIndex.INFO.
+
+Testing
+*******
+
+To test localy (with cloning the GitHub repository) you'll need to install the dependencies and run the coverage command as
+
+.. code:: python
+
+   >>> git clone https://github.com/MartinPdeS/PyOptik.git
+   >>> cd TradeTide
+   >>> pip install -r requirements/requirements.txt
+   >>> pytest
+
+----
+
+
+Contact Information
+************************
+As of 2024, the project is still under development. If you want to collaborate, it would be a pleasure! I encourage you to contact me.
+
+PyOptik was written by `Martin Poinsinet de Sivry-Houle <https://github.com/MartinPdS>`_  .
+
+Email:`martin.poinsinet-de-sivry@polymtl.ca <mailto:martin.poinsinet-de-sivry@polymtl.ca?subject=PyOptik>`_ .
+
+
+.. |python| image:: https://img.shields.io/pypi/pyversions/pyoptik.svg
+   :target: https://www.python.org/
+
+.. |Logo| image:: https://github.com/MartinPdeS/PyOptik/raw/master/docs/images/logo.png
+
+.. |docs| image:: https://readthedocs.org/projects/pyoptik/badge/?version=latest
+   :target: https://pyoptik.readthedocs.io/en/latest/
+
+.. |PyPi| image:: https://badge.fury.io/py/pyoptik.svg
+    :target: https://badge.fury.io/py/pyoptik
+
+.. |PyPi_download| image:: https://img.shields.io/pypi/dm/pyoptik.svg
+   :target: https://pypistats.org/packages/pyoptik
+
+.. |unittest| image:: https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/MartinPdeS/8fa5a7d93dc020b1f624012220f6ebbd/raw/15873eb6e38185c878026b9474148b8daab96b2e/PyOptik_coverage_badge.json

pyoptik-0.7.11/PyOptik/VERSION

@@ -0,0 +1 @@
+0.7.11

pyoptik-0.7.11/PyOptik/__init__.py

@@ -0,0 +1,40 @@
+from PyOptik.experiment_material import DataMeasurement
+from PyOptik.sellmeier_material import Sellmeier
+import numpy
+import pandas
+
+
+class UsualMaterial:
+    BK7 = Sellmeier('BK7')
+    FusedSilica = Sellmeier('silica')
+    SodaLimeGlass = DataMeasurement('sodalimeglass')
+    Silver = DataMeasurement('silver')
+    Gold = DataMeasurement('gold')
+    Aluminium = DataMeasurement('aluminium')
+    SI = Sellmeier('silica')
+    SIO2 = DataMeasurement('sio2')
+    TIO2 = DataMeasurement('tio2')
+    Polystyrene = DataMeasurement('polystyrene')
+    Water = DataMeasurement('water')
+    Ethanol = DataMeasurement('ethanol')
+
+    @classmethod
+    def get_from_string(cls, material_str):
+        material_str = numpy.atleast_1d(material_str)
+
+        material_str = [
+            mat for mat in material_str if not pandas.isnull(mat)
+        ]
+
+        values = [
+            getattr(cls, string) for string in material_str
+        ]
+
+        values = numpy.asarray(values)
+
+        if values.size == 0:
+            return numpy.nan
+
+        return values
+
+# -

pyoptik-0.7.11/PyOptik/directories.py

@@ -0,0 +1,47 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+import os
+from pathlib import Path
+import PyOptik
+
+
+__all__ = [
+    'root_path',
+    'project_path',
+    'doc_path',
+    'doc_css_path',
+    'logo_path',
+    'version_path',
+]
+
+root_path = Path(PyOptik.__path__[0])
+
+project_path = root_path.parents[0]
+
+example_directory = root_path.joinpath('examples')
+
+doc_path = project_path.joinpath('docs')
+
+doc_css_path = doc_path.joinpath('source/_static/default.css')
+
+logo_path = doc_path.joinpath('images/logo.png')
+
+version_path = root_path.joinpath('VERSION')
+
+examples_path = root_path.joinpath('examples')
+
+ZeroPath = os.path.dirname(root_path)
+
+DataPath = os.path.join(root_path, 'Data')
+
+NPZPath = os.path.join(DataPath, 'npz')
+
+
+if __name__ == '__main__':
+    for path_name in __all__:
+        path = locals()[path_name]
+        print(path)
+        assert path.exists(), f"Path {path_name} do not exists"
+
+# -

pyoptik-0.7.11/PyOptik/experiment_material.py

@@ -0,0 +1,112 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+import os
+from typing import Union, Iterable
+from MPSTools.material_catalogue.loader import get_material_index
+from MPSPlots.render2D import SceneList
+
+from MPSTools.tools.directories import measurements_file_path
+from pydantic.dataclasses import dataclass
+
+
+def valid_name(string):
+    return not string.startswith('_')
+
+
+list_of_available_files = os.listdir(measurements_file_path)
+
+material_list = [element[:-5] for element in list_of_available_files]
+
+material_list = list(filter(valid_name, material_list))
+
+
+@dataclass
+class DataMeasurement():
+    """
+    A class for computing the refractive index using locally saved measurement data for specified materials.
+
+    Attributes:
+        material_name (str): The name of the material.
+
+    Methods:
+        reference (str): Returns the bibliographic reference for the material's data.
+        get_refractive_index: Computes the refractive index for given wavelength(s).
+        plot: Visualizes the refractive index as a function of wavelength.
+    """
+
+    material_name: str
+
+    def __post_init__(self):
+        """
+        Initializes the DataMeasurement object with a specified material name.
+
+        Parameters:
+            material_name (str): The name of the material for which to compute the refractive index.
+        """
+        if self.material_name not in material_list:
+            raise ValueError(f"{self.material_name} is not in the list of available materials.")
+
+    @property
+    def reference(self) -> str:
+        """
+        Retrieves the bibliographic reference for the material's data.
+
+        Returns:
+            str: The bibliographic reference for the material's measurement data.
+        """
+        raise NotImplementedError("Feature not implemented yet.")
+
+    def get_refractive_index(self, wavelength_range: Union[float, Iterable]) -> Union[float, Iterable]:
+        """
+        Computes the refractive index for the specified wavelength range using the material's measurement data.
+
+        Parameters:
+            wavelength_range (Union[float, Iterable]): The wavelength(s) in meters.
+
+        Returns:
+            Union[float, Iterable]: The refractive index or indices for the specified wavelength(s).
+        """
+        return get_material_index(
+            material_name=self.material_name,
+            wavelength=wavelength_range,
+            subdir='measurements'
+        )
+
+    def plot(self, wavelength_range: Iterable) -> SceneList:
+        """
+        Generates a plot of the refractive index as a function of wavelength for the specified material.
+
+        Parameters:
+            wavelength_range (Iterable): The range of wavelengths to plot.
+
+        Returns:
+            SceneList: An object containing the plot of refractive index against wavelength.
+        """
+        scene = SceneList()
+        ax = scene.append_ax(x_label='Wavelength [m]', y_label='Refractive index')
+
+        refractive_index = self.get_refractive_index(wavelength_range)
+        ax.add_line(x=wavelength_range, y=refractive_index, line_width=2)
+
+        return scene
+
+    def __repr__(self) -> str:
+        """
+        Provides a formal string representation of the DataMeasurement object.
+
+        Returns:
+            str: Formal representation of the object, showing the material name.
+        """
+        return str(self.material_name)
+
+    def __str__(self) -> str:
+        """
+        Provides an informal string representation of the DataMeasurement object.
+
+        Returns:
+            str: Informal representation of the object.
+        """
+        return self.__repr__()
+
+# -

pyoptik-0.7.11/PyOptik/sellmeier_material.py

@@ -0,0 +1,118 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+import os
+import numpy as np
+from typing import Union, Iterable
+from MPSTools.material_catalogue.loader import get_material_index
+from MPSPlots.render2D import SceneList
+from MPSTools.tools.directories import sellmeier_file_path
+from pydantic.dataclasses import dataclass
+
+
+def valid_name(string):
+    return not string.startswith('_')
+
+
+list_of_available_files = os.listdir(sellmeier_file_path)
+
+material_list = [element[:-5] for element in list_of_available_files]
+
+material_list = list(filter(valid_name, material_list))
+
+
+@dataclass
+class Sellmeier():
+    """
+    A class for computing the refractive index using the Sellmeier equation based on locally stored Sellmeier coefficients.
+
+    Attributes:
+        material_name (str): Name of the material.
+        sellmeier_coefficients (dict): Sellmeier coefficients for the material loaded from a local source.
+
+    Methods:
+        reference: Returns the reference for the Sellmeier coefficients.
+        get_refractive_index: Computes the refractive index for given wavelengths.
+        plot: Plots the refractive index as a function of the wavelength.
+    """
+    material_name: str
+
+    def __post_init__(self):
+        """
+        Initializes the DataMeasurement object with a specified material name.
+
+        Parameters:
+            material_name (str): The name of the material for which to compute the refractive index.
+        """
+        if self.material_name not in material_list:
+            raise ValueError(f"{self.material_name} is not in the list of available materials.")
+
+    @property
+    def reference(self) -> str:
+        """
+        Returns the bibliographic reference for the Sellmeier coefficients.
+
+        Returns:
+            str: The bibliographic reference.
+        """
+        return self.sellmeier_coefficients['sellmeier']['reference']
+
+    def get_refractive_index(self, wavelength_range: Union[float, Iterable]) -> Union[float, np.ndarray]:
+        """
+        Computes the refractive index for the specified wavelength(s) using the Sellmeier equation.
+
+        Parameters:
+            wavelength_range (Union[float, Iterable]): The wavelength(s) in meters for which to compute the refractive index.
+
+        Returns:
+            Union[float, np.ndarray]: The computed refractive index, either as a scalar or a NumPy array.
+        """
+        return_scalar = np.isscalar(wavelength_range)
+        wavelength_array = np.atleast_1d(wavelength_range).astype(float)
+
+        refractive_index = get_material_index(
+            material_name=self.material_name,
+            wavelength=wavelength_array,
+            subdir='sellmeier'
+        )
+
+        return refractive_index.item() if return_scalar else refractive_index
+
+    def plot(self, wavelength_range: Iterable) -> SceneList:
+        """
+        Plots the refractive index as a function of wavelength over a specified range.
+
+        Parameters:
+            wavelength_range (Iterable): The range of wavelengths to plot, in meters.
+
+        Returns:
+            SceneList: A SceneList object containing the plot.
+        """
+        scene = SceneList()
+        ax = scene.append_ax(x_label='Wavelength [m]', y_label='Refractive index')
+
+        refractive_index = self.get_refractive_index(wavelength_range)
+
+        ax.add_line(x=wavelength_range, y=refractive_index, line_width=2)
+
+        return scene
+
+    def __repr__(self) -> str:
+        """
+        Provides a formal string representation of the DataMeasurement object.
+
+        Returns:
+            str: Formal representation of the object, showing the material name.
+        """
+        return str(self.material_name)
+
+    def __str__(self) -> str:
+        """
+        Provides an informal string representation of the DataMeasurement object.
+
+        Returns:
+            str: Informal representation of the object.
+        """
+        return self.__repr__()
+
+# -

pyoptik-0.7.11/PyOptik.egg-info/PKG-INFO

@@ -0,0 +1,105 @@
+Metadata-Version: 2.1
+Name: PyOptik
+Version: 0.7.11
+Summary: A package/library for refractive index values.
+Home-page: https://github.com/MartinPdeS/PyOptik
+Author: Martin Poinsinet de Sivry
+Author-email: Martin.poinsinet.de.sivry@gmail.com
+License: MIT
+Keywords: refractive index
+Platform: unix
+Platform: linux
+Platform: osx
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Development Status :: 4 - Beta
+Classifier: Topic :: Scientific/Engineering :: Physics
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Intended Audience :: Science/Research
+Description-Content-Type: text/x-rst
+License-File: LICENSE
+Requires-Dist: pydantic==2.6.3
+Requires-Dist: matplotlib==3.8.2
+Requires-Dist: numpy>=1.26.0
+Requires-Dist: requests==2.31.0
+Requires-Dist: pandas==2.1.1
+Requires-Dist: bs4==0.0.1
+Requires-Dist: MPSTools==0.2.3
+Requires-Dist: MPSPlots>=1.4.2
+Provides-Extra: documentation
+Requires-Dist: numpydoc==1.6.0; extra == "documentation"
+Requires-Dist: sphinx>=5.1.1; extra == "documentation"
+Requires-Dist: sphinx-gallery==0.15.0; extra == "documentation"
+Requires-Dist: sphinx-rtd-theme==2.0.0; extra == "documentation"
+Requires-Dist: pydata-sphinx-theme==0.14.1; extra == "documentation"
+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: PyMieScatt==1.8.1.1; extra == "testing"
+
+|Logo|
+
+|python|
+|docs|
+|unittest|
+|PyPi|
+|PyPi_download|
+
+PyOptik
+=======
+
+
+
+PyOptik is a tool that can be used to import refractive indexes and extinction
+coefficients for different materials at different wavelengths. This data can then
+be used for different applications like simulating light interaction's with
+particules. All the data comes from RefractiveIndex.INFO.
+
+Testing
+*******
+
+To test localy (with cloning the GitHub repository) you'll need to install the dependencies and run the coverage command as
+
+.. code:: python
+
+   >>> git clone https://github.com/MartinPdeS/PyOptik.git
+   >>> cd TradeTide
+   >>> pip install -r requirements/requirements.txt
+   >>> pytest
+
+----
+
+
+Contact Information
+************************
+As of 2024, the project is still under development. If you want to collaborate, it would be a pleasure! I encourage you to contact me.
+
+PyOptik was written by `Martin Poinsinet de Sivry-Houle <https://github.com/MartinPdS>`_  .
+
+Email:`martin.poinsinet-de-sivry@polymtl.ca <mailto:martin.poinsinet-de-sivry@polymtl.ca?subject=PyOptik>`_ .
+
+
+.. |python| image:: https://img.shields.io/pypi/pyversions/pyoptik.svg
+   :target: https://www.python.org/
+
+.. |Logo| image:: https://github.com/MartinPdeS/PyOptik/raw/master/docs/images/logo.png
+
+.. |docs| image:: https://readthedocs.org/projects/pyoptik/badge/?version=latest
+   :target: https://pyoptik.readthedocs.io/en/latest/
+
+.. |PyPi| image:: https://badge.fury.io/py/pyoptik.svg
+    :target: https://badge.fury.io/py/pyoptik
+
+.. |PyPi_download| image:: https://img.shields.io/pypi/dm/pyoptik.svg
+   :target: https://pypistats.org/packages/pyoptik
+
+.. |unittest| image:: https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/MartinPdeS/8fa5a7d93dc020b1f624012220f6ebbd/raw/15873eb6e38185c878026b9474148b8daab96b2e/PyOptik_coverage_badge.json

pyoptik-0.7.11/PyOptik.egg-info/SOURCES.txt

@@ -0,0 +1,35 @@
+LICENSE
+MANIFEST.in
+README.rst
+pyproject.toml
+setup.cfg
+setup.py
+PyOptik/VERSION
+PyOptik/__init__.py
+PyOptik/directories.py
+PyOptik/experiment_material.py
+PyOptik/sellmeier_material.py
+PyOptik.egg-info/PKG-INFO
+PyOptik.egg-info/SOURCES.txt
+PyOptik.egg-info/dependency_links.txt
+PyOptik.egg-info/requires.txt
+PyOptik.egg-info/top_level.txt
+PyOptik/__pycache__/__init__.cpython-310.pyc
+PyOptik/__pycache__/experiment_material.cpython-310.pyc
+PyOptik/__pycache__/sellmeier_material.cpython-310.pyc
+docs/examples/measurements_tio2.py
+docs/examples/measurements_water.py
+docs/examples/sellmeier_bk7.py
+docs/examples/sellmeier_sf5.py
+docs/examples/sellmeier_silica.py
+docs/source/conf.py
+docs/source/gallery/add_material.py
+docs/source/gallery/get_values.py
+docs/source/gallery/plot_sellmeier_0.py
+docs/source/gallery/plot_sellmeier_1.py
+tests/__init__.py
+tests/test_measurements.py
+tests/test_sellmeier.py
+tests/__pycache__/__init__.cpython-310.pyc
+tests/__pycache__/test_measurements.cpython-310.pyc
+tests/__pycache__/test_sellmeier.cpython-310.pyc

pyoptik-0.7.11/PyOptik.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

pyoptik-0.7.11/PyOptik.egg-info/requires.txt

@@ -0,0 +1,25 @@
+pydantic==2.6.3
+matplotlib==3.8.2
+numpy>=1.26.0
+requests==2.31.0
+pandas==2.1.1
+bs4==0.0.1
+MPSTools==0.2.3
+MPSPlots>=1.4.2
+
+[documentation]
+numpydoc==1.6.0
+sphinx>=5.1.1
+sphinx-gallery==0.15.0
+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
+PyMieScatt==1.8.1.1

pyoptik-0.7.11/PyOptik.egg-info/top_level.txt

@@ -0,0 +1,3 @@
+PyOptik
+dist
+docs

pyoptik-0.7.11/README.rst

@@ -0,0 +1,57 @@
+|Logo|
+
+|python|
+|docs|
+|unittest|
+|PyPi|
+|PyPi_download|
+
+PyOptik
+=======
+
+
+
+PyOptik is a tool that can be used to import refractive indexes and extinction
+coefficients for different materials at different wavelengths. This data can then
+be used for different applications like simulating light interaction's with
+particules. All the data comes from RefractiveIndex.INFO.
+
+Testing
+*******
+
+To test localy (with cloning the GitHub repository) you'll need to install the dependencies and run the coverage command as
+
+.. code:: python
+
+   >>> git clone https://github.com/MartinPdeS/PyOptik.git
+   >>> cd TradeTide
+   >>> pip install -r requirements/requirements.txt
+   >>> pytest
+
+----
+
+
+Contact Information
+************************
+As of 2024, the project is still under development. If you want to collaborate, it would be a pleasure! I encourage you to contact me.
+
+PyOptik was written by `Martin Poinsinet de Sivry-Houle <https://github.com/MartinPdS>`_  .
+
+Email:`martin.poinsinet-de-sivry@polymtl.ca <mailto:martin.poinsinet-de-sivry@polymtl.ca?subject=PyOptik>`_ .
+
+
+.. |python| image:: https://img.shields.io/pypi/pyversions/pyoptik.svg
+   :target: https://www.python.org/
+
+.. |Logo| image:: https://github.com/MartinPdeS/PyOptik/raw/master/docs/images/logo.png
+
+.. |docs| image:: https://readthedocs.org/projects/pyoptik/badge/?version=latest
+   :target: https://pyoptik.readthedocs.io/en/latest/
+
+.. |PyPi| image:: https://badge.fury.io/py/pyoptik.svg
+    :target: https://badge.fury.io/py/pyoptik
+
+.. |PyPi_download| image:: https://img.shields.io/pypi/dm/pyoptik.svg
+   :target: https://pypistats.org/packages/pyoptik
+
+.. |unittest| image:: https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/MartinPdeS/8fa5a7d93dc020b1f624012220f6ebbd/raw/15873eb6e38185c878026b9474148b8daab96b2e/PyOptik_coverage_badge.json

pyoptik-0.7.11/docs/examples/measurements_tio2.py

@@ -0,0 +1,23 @@
+"""
+Plot the Refractive Index of Optical Material: Ti02
+===================================================
+
+This module demonstrates the usage of the PyOptik library to calculate and plot the refractive index of the optical material SF5 over a specified range of wavelengths.
+
+"""
+
+import numpy
+from PyOptik import DataMeasurement
+
+# Initialize the material with the Sellmeier model
+material = DataMeasurement('tio2')
+
+# Calculate refractive index at specific wavelengths
+RI = material.get_refractive_index(wavelength_range=[1310e-9, 1550e-9])
+
+# Display calculated refractive indices at sample wavelengths
+figure = material.plot(
+    wavelength_range=numpy.linspace(10e-9, 3500e-9, 300)
+)
+
+figure.show()

pyoptik-0.7.11/docs/examples/measurements_water.py

@@ -0,0 +1,23 @@
+"""
+Plot the Refractive Index of Optical Material: Water
+====================================================
+
+This module demonstrates the usage of the PyOptik library to calculate and plot the refractive index of the optical material SF5 over a specified range of wavelengths.
+
+"""
+
+import numpy
+from PyOptik import DataMeasurement
+
+# Initialize the material with the Sellmeier model
+material = DataMeasurement('water')
+
+# Calculate refractive index at specific wavelengths
+RI = material.get_refractive_index(wavelength_range=[1310e-9, 1550e-9])
+
+# Display calculated refractive indices at sample wavelengths
+figure = material.plot(
+    wavelength_range=numpy.linspace(300e-9, 3500e-9, 300)
+)
+
+figure.show()

pyoptik-0.7.11/docs/examples/sellmeier_bk7.py

@@ -0,0 +1,23 @@
+"""
+Plot the Refractive Index of Optical Material: BK7
+=====================================================
+
+This module demonstrates the usage of the PyOptik library to calculate and plot the refractive index of the optical material SF5 over a specified range of wavelengths.
+
+"""
+
+import numpy
+from PyOptik import Sellmeier
+
+# Initialize the material with the Sellmeier model
+material = Sellmeier('BK7')
+
+# Calculate refractive index at specific wavelengths
+RI = material.get_refractive_index(wavelength_range=[1310e-9, 1550e-9])
+
+# Display calculated refractive indices at sample wavelengths
+figure = material.plot(
+    wavelength_range=numpy.linspace(300e-9, 3500e-9, 300)
+)
+
+figure.show()

pyoptik-0.7.11/docs/examples/sellmeier_sf5.py

@@ -0,0 +1,23 @@
+"""
+Plot the Refractive Index of Optical Material: SF5
+==================================================
+
+This module demonstrates the usage of the PyOptik library to calculate and plot the refractive index of the optical material SF5 over a specified range of wavelengths.
+
+"""
+
+import numpy
+from PyOptik import Sellmeier
+
+# Initialize the material with the Sellmeier model
+material = Sellmeier('SF5')
+
+# Calculate refractive index at specific wavelengths
+RI = material.get_refractive_index(wavelength_range=[1310e-9, 1550e-9])
+
+# Display calculated refractive indices at sample wavelengths
+figure = material.plot(
+    wavelength_range=numpy.linspace(300e-9, 3500e-9, 300)
+)
+
+figure.show()

pyoptik-0.7.11/docs/examples/sellmeier_silica.py

@@ -0,0 +1,23 @@
+"""
+Plot the Refractive Index of Optical Material: Silica
+=====================================================
+
+This module demonstrates the usage of the PyOptik library to calculate and plot the refractive index of the optical material SF5 over a specified range of wavelengths.
+
+"""
+
+import numpy
+from PyOptik import Sellmeier
+
+# Initialize the material with the Sellmeier model
+material = Sellmeier('silica')
+
+# Calculate refractive index at specific wavelengths
+RI = material.get_refractive_index(wavelength_range=[1310e-9, 1550e-9])
+
+# Display calculated refractive indices at sample wavelengths
+figure = material.plot(
+    wavelength_range=numpy.linspace(300e-9, 3500e-9, 300)
+)
+
+figure.show()

pyoptik-0.7.11/docs/source/conf.py

@@ -0,0 +1,168 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+import sys
+from sphinx_gallery.sorting import FileNameSortKey
+from packaging.version import parse
+from MPSPlots.styles import use_mpsplots_style
+
+
+from PyOptik.directories import (
+    project_path,
+    doc_css_path,
+    version_path,
+)
+
+
+sys.path.insert(0, project_path)
+sys.path.insert(0, project_path.joinpath('PyOptik'))
+
+
+def setup(app):
+    app.add_css_file(str(doc_css_path))
+
+
+autodoc_mock_imports = [
+    'numpy',
+    'matplotlib',
+    'scipy'
+    'numpydoc',
+    'MPSPlots',
+]
+
+
+project = 'PyOptik'
+copyright = '2024, Martin Poinsinet de Sivry-Houle'
+author = 'Martin Poinsinet de Sivry-Houle'
+
+
+with open(version_path, "r+") as f:
+    version = release = f.read()
+
+
+extensions = [
+    'sphinx.ext.mathjax',
+    'numpydoc',
+    'sphinx_gallery.gen_gallery',
+]
+
+
+def reset_mpl(gallery_conf, fname):
+    use_mpsplots_style()
+
+
+sphinx_gallery_conf = {
+    'examples_dirs': '../examples',
+    'gallery_dirs': 'gallery',
+    'image_scrapers': ('matplotlib'),
+    'ignore_pattern': '/__',
+    'plot_gallery': True,
+    'thumbnail_size': [600, 600],
+    'download_all_examples': False,
+    'reset_modules': reset_mpl,
+    'line_numbers': False,
+    'remove_config_comments': True,
+    'within_subsection_order': FileNameSortKey,
+    'capture_repr': ('_repr_html_', '__repr__'),
+    'nested_sections': True,
+}
+
+
+autodoc_default_options = {
+    'members': False,
+    'members-order': 'bysource',
+    'undoc-members': False,
+    'show-inheritance': True,
+}
+
+numpydoc_show_class_members = False
+
+source_suffix = '.rst'
+
+master_doc = 'index'
+
+language = 'en'
+
+highlight_language = 'python3'
+
+html_theme = "pydata_sphinx_theme"
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+exclude_trees = []
+default_role = "autolink"
+pygments_style = "sphinx"
+
+# -- Sphinx-gallery configuration --------------------------------------------
+
+v = parse(release)
+if v.release is None:
+    raise ValueError(f"Ill-formed version: {version!r}. Version should follow PEP440")
+
+if v.is_devrelease:
+    binder_branch = "main"
+else:
+    major, minor = v.release[:2]
+    binder_branch = f"v{major}.{minor}.x"
+
+html_theme_options = {
+    # Navigation bar
+    "logo": {
+        "alt_text": "PyOptik's logo",
+        "text": "PyOptik",
+        "link": "https://pyoptik.readthedocs.io/en/latest/",
+    },
+    "icon_links": [
+        {
+            "name": "GitHub",
+            "url": "https://github.com/MartinPdeS/PyOptik",
+            "icon": "fa-brands fa-github",
+        },
+        {
+            "name": "PyPI",
+            "url": "https://pypi.org/project/pyoptik/",
+            "icon": "fa-solid fa-box",
+        },
+    ],
+    "navbar_align": "left",
+    "navbar_end": ["version-switcher", "navbar-icon-links"],
+    "show_prev_next": False,
+    "show_version_warning_banner": True,
+    # Footer
+    "footer_start": ["copyright"],
+    "footer_end": ["sphinx-version", "theme-version"],
+    # Other
+    "pygment_light_style": "default",
+    "pygment_dark_style": "github-dark",
+}
+
+htmlhelp_basename = 'PyOptikdoc'
+
+latex_elements = {}
+
+
+latex_documents = [
+    (master_doc, 'PyOptik.tex', 'PyOptik Documentation',
+     'Martin Poinsinet de Sivry-Houle', 'manual'),
+]
+
+man_pages = [
+    (master_doc, 'supymode', 'PyOptik Documentation',
+     [author], 1)
+]
+
+texinfo_documents = [
+    (master_doc, 'PyOptik', 'PyOptik Documentation',
+     author, 'PyOptik', 'One line description of project.',
+     'Miscellaneous'),
+]
+
+epub_title = project
+
+html_static_path = ['_static']
+templates_path = ['_templates']
+html_css_files = ['default.css']
+epub_exclude_files = ['search.html']
+
+# -

pyoptik-0.7.11/docs/source/gallery/add_material.py

@@ -0,0 +1,16 @@
+"""
+Add hoc docstring
+=================
+
+"""
+
+from PyOptik import DataBank
+from PyOptik.ExpData import SaveData
+
+print(DataBank())
+
+url = 'https://refractiveindex.info/data_csv.php?datafile=data/main/Si/Aspnes.yml'
+
+SaveData(name='SI', url=url)
+
+print(DataBank())

pyoptik-0.7.11/docs/source/gallery/get_values.py

@@ -0,0 +1,14 @@
+"""
+Add hoc docstring
+=================
+
+"""
+
+from PyOptik import DataBank, ExpData
+
+print(DataBank())
+
+dat = ExpData('BK7')
+
+dat.GetRI([5e-7])
+

pyoptik-0.7.11/docs/source/gallery/plot_sellmeier_0.py

@@ -0,0 +1,19 @@
+"""
+Plot refractive index of material: BK7
+======================================
+
+"""
+
+import numpy
+from PyOptik import Sellmeier
+
+
+material = Sellmeier('BK7')
+
+RI = material.get_refractive_index(wavelength=[1310e-9, 1550e-9])
+
+figure = material.plot(
+    wavelength_range=numpy.linspace(300e-9, 3500e-9, 300)
+)
+
+figure.show()

pyoptik-0.7.11/docs/source/gallery/plot_sellmeier_1.py

@@ -0,0 +1,19 @@
+"""
+Plot refractive index of material: Silica
+=========================================
+
+"""
+
+import numpy
+from PyOptik import Sellmeier
+
+
+material = Sellmeier('silica')
+
+RI = material.get_refractive_index(wavelength=[1310e-9, 1550e-9])
+
+figure = material.plot(
+    wavelength_range=numpy.linspace(300e-9, 3500e-9, 300)
+)
+
+figure.show()

pyoptik-0.7.11/pyproject.toml

@@ -0,0 +1,10 @@
+[tool.pytest.ini_options]
+addopts = [
+    "--import-mode=importlib",
+    '-v',
+    '-ra',
+]
+
+testpaths = "tests"
+
+minversion = 6.0

pyoptik-0.7.11/setup.cfg

@@ -0,0 +1,84 @@
+[metadata]
+name = PyOptik
+description = A package/library for refractive index values.
+keywords = 
+	refractive index
+version = file: PyOptik/VERSION
+long_description = file: README.rst
+long_description_content_type = text/x-rst
+author = Martin Poinsinet de Sivry
+author_email = Martin.poinsinet.de.sivry@gmail.com
+platforms = unix, linux, osx
+url = https://github.com/MartinPdeS/PyOptik
+license = MIT
+license_files = LICENSE
+readme = README.rst
+documentation = https://pyoptik.readthedocs.io/
+classifiers = 
+	Programming Language :: Python
+	Programming Language :: Python :: 3
+	Programming Language :: Python :: 3.10
+	Programming Language :: Python :: 3.11
+	Programming Language :: Python :: 3.12
+	Programming Language :: Python :: Implementation :: CPython
+	Development Status :: 4 - Beta
+	Topic :: Scientific/Engineering :: Physics
+	License :: OSI Approved :: MIT License
+	Intended Audience :: Science/Research
+
+[options]
+packages = find_namespace:
+include_package_data = True
+python_requires > = 3.8
+install_requires = 
+	pydantic==2.6.3
+	matplotlib==3.8.2
+	numpy>=1.26.0
+	requests==2.31.0
+	pandas==2.1.1
+	bs4==0.0.1
+	MPSTools==0.2.3
+	MPSPlots>=1.4.2
+setup_requires = 
+	setuptools>=69.0.2
+
+[options.packages.find]
+exclude = 
+	extern
+	docs
+	tests
+
+[options.extras_require]
+documentation = 
+	numpydoc==1.6.0
+	sphinx>=5.1.1
+	sphinx-gallery==0.15.0
+	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
+	PyMieScatt==1.8.1.1
+
+[flake8]
+max-line-length = 200
+per-file-ignores = __init__.py:F401
+ignore = W605
+
+[coverage:run]
+source = PyOptik
+omit = 
+	PyOptik/validation_data/*
+
+[sdist]
+formats = zip, gztar
+
+[egg_info]
+tag_build = 
+tag_date = 0
+

pyoptik-0.7.11/setup.py

@@ -0,0 +1,6 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+from setuptools import setup
+
+setup()

pyoptik-0.7.11/tests/test_measurements.py

@@ -0,0 +1,22 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+import numpy
+from unittest.mock import patch
+import pytest
+from PyOptik import DataMeasurement
+from PyOptik.experiment_material import material_list
+
+
+@pytest.mark.parametrize('material_name', material_list, ids=material_list)
+@patch("matplotlib.pyplot.show")
+def test_material_plot(patch, material_name: str):
+    material = DataMeasurement(material_name)
+
+    wavelength_range = numpy.linspace(400e-9, 1000e-9, 30)
+
+    figure = material.plot(wavelength_range=wavelength_range)
+
+    figure.show()
+
+# -

pyoptik-0.7.11/tests/test_sellmeier.py

@@ -0,0 +1,23 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+import numpy
+from unittest.mock import patch
+import pytest
+from PyOptik import Sellmeier
+from PyOptik.sellmeier_material import material_list
+
+
+@pytest.mark.parametrize('material_name', material_list, ids=material_list)
+@patch("matplotlib.pyplot.show")
+def test_material_plot(patch, material_name: str):
+    material = Sellmeier(material_name)
+
+    wavelength_range = numpy.linspace(400e-9, 1000e-9, 30)
+
+    figure = material.plot(wavelength_range=wavelength_range)
+
+    figure.show()
+
+
+# -