PyOptik 1.9.8__0-py3-none-any.whl

PyOptik/units.py

@@ -0,0 +1,56 @@
+from typing import Optional
+import pint
+
+ureg = pint.UnitRegistry()
+pint.set_application_registry(ureg)
+
+# Define a list of base units to scale
+BASE_UNITS = [
+    'meter'
+]
+
+# Define prefixes for scaling units
+SCALES = ['nano', 'micro', 'milli', '', 'kilo', 'mega']
+
+
+def initialize_registry(ureg: Optional[pint.UnitRegistry] = None) -> None:
+    """
+    Initialize and set up a unit registry. This function also leaks
+    the units into the global namespace for easy access throughout
+    the module.
+
+    Parameters
+    ----------
+    ureg: Optional[pint.UnitRegistry]
+        A UnitRegistry object to use. If None, the default PintType.ureg will be used.
+    """
+
+    # If no unit registry is provided, use the default
+    ureg = ureg or pint.UnitRegistry()
+
+    # Set up matplotlib integration and unit formatting
+    ureg.setup_matplotlib()
+    ureg.formatter.default_format = '~P'  # Compact format without units like 'meter'
+
+    # Leak scaled units into the global namespace
+    for unit in BASE_UNITS:
+        for scale in SCALES:
+            scaled_unit_name = scale + unit
+            globals()[scaled_unit_name] = getattr(ureg, scaled_unit_name)
+
+    # Leak commonly used specific units into the global namespace
+    common_units = {
+        'RIU': ureg.refractive_index_unit,
+        'refractive_index_unit': ureg.refractive_index_unit,
+        'AU': ureg.dimensionless,
+        'distance': ureg.meter.dimensionality,
+        'Quantity': ureg.Quantity
+    }
+
+    # Leak the common units into the global namespace
+    globals().update(common_units)
+
+    globals()['ureg'] = ureg
+
+
+initialize_registry(ureg)

PyOptik/utils.py

@@ -0,0 +1,46 @@
+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.9.8.0.dist-info/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-1.9.8.0.dist-info/METADATA

@@ -0,0 +1,295 @@
+Metadata-Version: 2.1
+Name: PyOptik
+Version: 1.9.8.0
+Summary: A package for refractive index values.
+Author-email: Martin Poinsinet de Sivry-Houle <martin.poinsinet.de.sivry@gmail.com>
+License: 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.
+        
+Keywords: refracive index,optics
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+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
+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~=1.26
+Requires-Dist: matplotlib~=3.8
+Requires-Dist: requests~=2.31
+Requires-Dist: pyyaml~=6.0
+Requires-Dist: MPSPlots~=1.5.1
+Requires-Dist: tabulate~=0.9
+Provides-Extra: dev
+Requires-Dist: flake8==7.1.1; extra == "dev"
+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<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: coverage~=7.6; extra == "testing"
+
+
+|logo|
+
+.. list-table::
+   :widths: 10 25 25
+   :header-rows: 0
+
+   * - Meta
+     - |python|
+     - |docs|
+   * - Testing
+     - |ci/cd|
+     - |coverage|
+   * - PyPi
+     - |PyPi|
+     - |PyPi_download|
+   * - Anaconda
+     - |anaconda|
+     - |anaconda_download|
+
+
+PyOptik
+=======
+
+PyOptik is a Python tool designed to import refractive indexes and extinction coefficients for various materials across different wavelengths. The data provided by PyOptik can be used in numerous applications, including simulating light interactions with particles. All data is sourced from the reputable RefractiveIndex.INFO database.
+
+
+
+Features
+********
+
+- **Comprehensive Database Access**: Seamlessly import refractive index and extinction coefficient data for a wide range of materials.
+- **Simulation Ready**: Ideal for light-matter interaction simulations, particularly in optics and photonics.
+- **Simple API**: Easy-to-use API that integrates well with other Python libraries.
+- **Open Source**: Fully open-source.
+
+Installation
+************
+
+To install PyOptik, simply use `pip` or `conda`:
+
+.. code:: bash
+
+   pip install PyOptik
+   conda install --channels martinpdes pyoptik
+
+Building the Material Library
+*****************************
+
+PyOptik allows you to build and customize a local material library, importing material data from various categories. You can download the following categories of materials from the RefractiveIndex.INFO database:
+
+- `classics`: Commonly used optical materials.
+- `glasses`: Various types of glass materials.
+- `metals`: Different metal materials for optical simulations.
+- `organics`: Organic materials with optical properties.
+- `others`: Other optical materials.
+- `all`: Download all available categories at once.
+
+To build a material library, use the `build_library` function. This will download and save the material data to your local machine.
+
+**Example: Building the Material Library:**
+
+In this example, we will download the `others` category of materials and remove any previously existing data in that category:
+
+.. code:: python
+
+   from PyOptik import MaterialBank
+
+   # Download the 'classics' category and remove previous files
+   MaterialBank.build_library('classics', remove_previous=True)
+
+**Available Categories:**
+
+To download materials from another category, simply pass the category name as an argument to `build_library`. For example:
+
+.. code:: python
+
+   # Download materials from the 'glasses' category
+   MaterialBank.build_library('glasses')
+
+To download all material categories at once:
+
+.. code:: python
+
+   # Download all available material categories
+   MaterialBank.build_library('all')
+
+You can also set the `remove_previous` parameter to `True` to remove old data before downloading new material data.
+
+Viewing Available Materials
+***************************
+
+Once you have built the material library, you can view all the available materials using the `MaterialBank` class. This will print a list of materials stored in your local library.
+
+**Example:**
+
+.. code:: python
+
+   from PyOptik import MaterialBank
+
+   # Print the available materials in a tabulated format
+   MaterialBank.print_materials()
+
+Simple Usage
+************
+
+After installing PyOptik and building the material library, you can easily access material properties:
+
+.. code:: python
+
+   from PyOptik import MaterialBank
+
+   # Access the refractive index of BK7 glass
+   bk7 = MaterialBank.BK7
+   n = bk7.compute_refractive_index(0.55e-6)
+   print(f"Refractive index at 0.55 µm: {n}")
+
+Example
+*******
+
+Here is a quick example demonstrating how to use PyOptik to retrieve and plot the refractive index of a material:
+
+.. code:: python
+
+   import numpy as np
+   from PyOptik import MaterialBank
+
+   # Define wavelength range
+   wavelengths = np.linspace(0.3e-6, 2.5e-6, 100)
+
+   # Retrieve refractive index for BK7 glass
+   bk7 = MaterialBank.BK7
+   n_values = bk7.compute_refractive_index(wavelengths)
+
+   # Plot the results
+   bk7.plot()
+
+This code produces the following figure: |example_bk7|
+
+Adding and Removing Custom Materials
+************************************
+
+You can add a custom material to your library by providing a URL from `refractiveindex.info <https://refractiveindex.info>`_.
+
+**Adding a Custom Material:**
+
+.. code:: python
+
+   from PyOptik import MaterialBank, MaterialType
+
+   # Define the URL of the YAML file and the destination
+   # Call the function to download the file
+   MaterialBank.add_material_to_bank(
+      filename='example_download',
+      material_type=MaterialType.SELLMEIER,
+      url='https://refractiveindex.info/database/data-nk/main/H2O/Daimon-19.0C.yml'
+   )
+
+   MaterialBank.print_available()
+
+**Removing a Material:**
+
+You can also remove a material from the library as follows:
+
+.. code:: python
+
+   from PyOptik.utils import remove_element
+
+   MaterialBank.remove_item(filename='example_download')
+
+Testing
+*******
+
+To test locally after cloning the GitHub repository, install the dependencies and run the tests:
+
+.. code:: bash
+
+   git clone https://github.com/MartinPdeS/PyOptik.git
+   cd PyOptik
+   pip install .
+   pytest
+
+Contributing
+************
+
+PyOptik is open to contributions. Whether you're fixing bugs, adding new features, or improving documentation, your help is welcome! Please feel free to fork the repository and submit pull requests.
+
+Contact Information
+*******************
+
+As of 2024, PyOptik is still under development. If you would like to collaborate, it would be a pleasure to hear from you. Contact me at:
+
+**Author**: `Martin Poinsinet de Sivry-Houle <https://github.com/MartinPdS>`_
+
+**Email**: `martin.poinsinet.de.sivry@gmail.com <mailto:martin.poinsinet.de.sivry@gmail.com?subject=PyOptik>`_
+
+.. |python| image:: https://img.shields.io/pypi/pyversions/pyoptik.svg
+   :alt: Python
+   :target: https://www.python.org/
+
+.. |logo| image:: https://github.com/MartinPdeS/PyOptik/raw/master/docs/images/logo.png
+   :alt: PyOptik logo
+
+.. |example_bk7| image:: https://github.com/MartinPdeS/PyOptik/raw/master/docs/images/example_bk7.png
+   :alt: PyOptik example: BK7
+   :target: https://github.com/MartinPdeS/PyOptik/blob/master/docs/images/example_bk7.png
+
+.. |docs| image:: https://github.com/martinpdes/pyoptik/actions/workflows/deploy_documentation.yml/badge.svg
+   :target: https://martinpdes.github.io/PyOptik/
+   :alt: Documentation Status
+
+.. |ci/cd| image:: https://github.com/martinpdes/pyoptik/actions/workflows/deploy_coverage.yml/badge.svg
+   :target: https://martinpdes.github.io/PyOptik/actions
+   :alt: Unittest Status
+
+.. |PyPi| image:: https://badge.fury.io/py/pyoptik.svg
+   :alt: PyPi version
+   :target: https://badge.fury.io/py/pyoptik
+
+.. |PyPi_download| image:: https://img.shields.io/pypi/dm/pyoptik.svg
+   :alt: PyPi version
+   :target: https://pypistats.org/packages/pyoptik
+
+.. |anaconda_download| image:: https://anaconda.org/martinpdes/pyoptik/badges/downloads.svg
+   :alt: Anaconda downloads
+   :target: https://anaconda.org/martinpdes/pyoptik
+
+.. |coverage| image:: https://raw.githubusercontent.com/MartinPdeS/PyOptik/python-coverage-comment-action-data/badge.svg
+   :alt: Unittest coverage
+   :target: https://htmlpreview.github.io/?https://github.com/MartinPdeS/PyOptik/blob/python-coverage-comment-action-data/htmlcov/index.html
+
+.. |anaconda| image:: https://anaconda.org/martinpdes/pyoptik/badges/version.svg
+   :alt: Anaconda version
+   :target: https://anaconda.org/martinpdes/pyoptik

PyOptik-1.9.8.0.dist-info/RECORD

@@ -0,0 +1,50 @@
+PyOptik/__init__.py,sha256=KWTEeNX6WB_LSvjtks_KIsUL62lgv4m_Y6GgcFUYytY,364
+PyOptik/__main__.py,sha256=GG4Hib_1ouWvHBexSTXF1NXIc6Vd3-lgnOnfQcGCqB4,166
+PyOptik/_version.py,sha256=ww4t_XNUVgmR-vflLfkYIvQwzjnLzxJfdUKiVD9Cjjg,416
+PyOptik/directories.py,sha256=eOQQ6FmMdLX4X6f3jMgNg73ZkaIZ7lct1xK5cr2JgFw,916
+PyOptik/material_bank.py,sha256=a8lcMGAGC4VmtyEXQP6tzk-btjMrmpsTmFna1IXDxKU,16833
+PyOptik/material_type.py,sha256=tF0-_5oyhAJJP7AXFtTs5cMlx-K99__Jw_5AsxSkWKc,153
+PyOptik/units.py,sha256=j4Kvmj-JN92O9_pEFAnUGuMrAuPXGgvvy_hqvHAlDjo,1619
+PyOptik/utils.py,sha256=EcyPJEtD-MXH9cBmphI85BtL7ctx12zg04kVOW_bf8E,1612
+PyOptik/data/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+PyOptik/data/sellmeier/BAK1.yml,sha256=DFeUQ3cO_gRxjsWbspIIIhYomkraFGNlPUSK2vhM1Y0,2093
+PyOptik/data/sellmeier/BK7.yml,sha256=QRA_2LJqpDsr5fN_qs7wyKLN9xQtaqwgAbWA3F9evIQ,2101
+PyOptik/data/sellmeier/SF5.yml,sha256=ADIMWCQwi8DokOnXaKefVOgM9nBbVS0_3C2TAFeMO7s,1956
+PyOptik/data/sellmeier/ZBLAN.yml,sha256=z7xj98GmREpvWmyZctkeWwL14t7u73cimOWAkXJ5E4Q,498
+PyOptik/data/sellmeier/air.yml,sha256=cy0gqR7a84YpedKCKoaricbGQjFGa3nWj-US8jYuG9A,1000
+PyOptik/data/sellmeier/argon.yml,sha256=NoNBb5_xhAvtbLzm3AsGA3mjJqE86hxGznqYgp9vXYs,1176
+PyOptik/data/sellmeier/crown.yml,sha256=xmiEl5Fd9-5n3jQzI4i3RrKn8d2_ia-mYeFcXAT6Ues,2049
+PyOptik/data/sellmeier/flint.yml,sha256=zV-_VZPFJVKQtpwqG-XI1BgcUruhlfvZhZaRziObqfQ,2042
+PyOptik/data/sellmeier/fused_silica.yml,sha256=WBcZxonM7oZ6GHFC6hxH8xM77eshmKFoPl3Kq1ZxbGw,1023
+PyOptik/data/sellmeier/germanium.yml,sha256=8pGjyaHGcDUIdumb9hC7w2y60iuH67nkHtXSHiu1i9Y,837
+PyOptik/data/sellmeier/lithium_niobate.yml,sha256=_kNo_aXQN148tSm9Mo2dSTVrrq0sagb6p5iPV5DTk4s,659
+PyOptik/data/sellmeier/polystyren.yml,sha256=8wD6LsHnL5VQ7NmjEa59iV0lp5FlrNvXRdKX8oltO1c,698
+PyOptik/data/sellmeier/silicon.yml,sha256=lwvE7Y6ZTIBZ8FqvqKixmsmXFXPJEJKLHKCPDDHRkLM,834
+PyOptik/data/sellmeier/soda_lime_glass.yml,sha256=_h65OrsirpfHZqK5kRWRT0vRrdGVLRdv8LhRQMKLock,2983
+PyOptik/data/sellmeier/water.yml,sha256=1GgeHdtymY7WABw0nrwz4bARKzcLB5LJv2RKTD6w478,800
+PyOptik/data/tabulated/aluminium.yml,sha256=cyaun8GEOjh_84oOthSGjA4cdqFMeneksjem9FWbLt0,9366
+PyOptik/data/tabulated/calcium.yml,sha256=6L2_8hwB9t0ZsjSj-OqE4KUW0IS9sR4bcQpgIf4YOnQ,2486
+PyOptik/data/tabulated/copper.yml,sha256=SKrKPd_vaUw4dIqDqyM7BxX2rRYzuReV9-B_xX9RVxk,1751
+PyOptik/data/tabulated/gold.yml,sha256=fJG4A7rh08heYb4Po7OLxMFN2PNhB8rJf2vQRcWpxgc,1751
+PyOptik/data/tabulated/iron.yml,sha256=rHq148cXs1PKE9GWJCJEMLjVCopHwkqtH8q-LH639eY,1689
+PyOptik/data/tabulated/nickel.yml,sha256=QrQm7tE7W7qXFEfLr8PlXW8LyfAUATo1zMvN5y2E6Cw,1689
+PyOptik/data/tabulated/silver.yml,sha256=hpbFAAJFeUAhwseySE7g2FQUUTX1HF9sOQHdG9-bPyM,1751
+PyOptik/data/tabulated/sodium.yml,sha256=lHc2E9JZFGPIEDsVyuS74W-6j4iJy8rEA5C34p3JPEY,1318
+PyOptik/data/tabulated/zinc.yml,sha256=BVjj3pLBWGsZc0kl9cxhXLKksNENnLJwuD5TQTa4vx4,5440
+PyOptik/libraries/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+PyOptik/libraries/classics.yml,sha256=oDZliRP5xTsTMruL1uFHI_wH3gRDm1jvcxpCoUlxOyc,2033
+PyOptik/libraries/dielectrics.yml,sha256=Kp6t7BBiUC1XTjtVf2d-pkJr42nSs57UHeSGSbD9yGg,1492
+PyOptik/libraries/metals.yml,sha256=nFFKP5R-ZtU6z3X6gAZsDhuPY3hIdCcL1_Sec_vvek8,1457
+PyOptik/libraries/minimal.yml,sha256=M2nkZ-L2cGnW-8uxWG5av_6lFqnxbZRwuuStgx_RmQc,523
+PyOptik/libraries/organics.yml,sha256=7YIP3tI1n86yBJmJlHZgGWWwHtbDEI5wf4VbORXKTuo,879
+PyOptik/libraries/others.yml,sha256=SkI9wlLqlgol1KhoHzag64Hw9AcCLYc8tT5Sv237574,258
+PyOptik/libraries/polymers.yml,sha256=XEo71yJiZRn8Pw7e0TJDrVunCVuLmVEgKa5ILoXkWp8,787
+PyOptik/material/__init__.py,sha256=2NkDtoPUboanWquiU_ljxqHc9Y6j2sVLZ_3epuT5xWQ,131
+PyOptik/material/base_class.py,sha256=L5nOTRIBsFo0h3FVcD1yb9iLu2svhgXG8Muz9baNMnY,2890
+PyOptik/material/sellmeier_class.py,sha256=7l5qCXGRtF9ewXPP8KrZUXS7MF6XPO9zYTbL-lMEGuI,7259
+PyOptik/material/tabulated_class.py,sha256=2uBLGwTR57OXQ8yadltHEMKcOTakcz1NRyWOuOeR-0c,6190
+PyOptik-1.9.8.0.dist-info/LICENSE,sha256=U6YG4UEW9XJzHa53oijR0qw6JNN_SZ38WOBmYn3NPd0,1072
+PyOptik-1.9.8.0.dist-info/METADATA,sha256=ZMjAeDEbGSdvism5R9KCLQZG9ipj7-TKqm_d9003aU4,10253
+PyOptik-1.9.8.0.dist-info/WHEEL,sha256=P9jw-gEje8ByB7_hXoICnHtVCrEwMQh-630tKvQWehc,91
+PyOptik-1.9.8.0.dist-info/top_level.txt,sha256=LDypi2J9ytpLl-OYs1sacn8X6O7-WdNgFPjlfVbNpI0,8
+PyOptik-1.9.8.0.dist-info/RECORD,,

PyOptik-1.9.8.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (75.3.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

PyOptik-1.9.8.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+PyOptik