PyOptik 1.3.1.post0__tar.gz → 1.4.0.post0__tar.gz

{pyoptik-1.3.1.post0 → pyoptik-1.4.0.post0}/.gitignore

@@ -6,6 +6,8 @@
 *htmlcov
 *.coverage
 developments/*
+PyOptik/data/**/test*
+PyOptik/data/**/example*
 
 dist
 build

{pyoptik-1.3.1.post0 → pyoptik-1.4.0.post0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: PyOptik
-Version: 1.3.1.post0
+Version: 1.4.0.post0
 Summary: A package for refractive index values.
 Author-email: Martin Poinsinet de Sivry-Houle <martin.poinsinet.de.sivry@gmail.com>
 License: MIT License
@@ -28,10 +28,6 @@ License: MIT License
 Keywords: refracive index,optics
 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 :: 3.13
 Classifier: Programming Language :: Python :: Implementation :: CPython
 Classifier: Development Status :: 4 - Beta
 Classifier: Topic :: Scientific/Engineering :: Physics

{pyoptik-1.3.1.post0 → pyoptik-1.4.0.post0}/PyOptik/__init__.py

@@ -7,4 +7,6 @@ except ImportError:
 
 from .utils import build_default_library
 from .material import UsualMaterial
-from .base_class import Material
+from .base_class import Material
+from .tabulated_class import TabulatedMaterial
+from .sellmeier_class import SellmeierMaterial

{pyoptik-1.3.1.post0 → pyoptik-1.4.0.post0}/PyOptik/_version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '1.3.1.post0'
-__version_tuple__ = version_tuple = (1, 3, 1)
+__version__ = version = '1.4.0.post0'
+__version_tuple__ = version_tuple = (1, 4, 0)

pyoptik-1.4.0.post0/PyOptik/utils.py

@@ -0,0 +1,171 @@
+
+import yaml
+from typing import Optional, List, Tuple, NoReturn
+import requests
+from PyOptik.directories import sellmeier_data_path, tabulated_data_path
+from PyOptik.data.sellmeier.default import default_material as sellmeier_default
+from PyOptik.data.tabulated.default import default_material as tabulated_default
+
+def download_yml_file(url: str, filename: str, location: str) -> NoReturn:
+    """
+    Downloads a .yml file from a specified URL and saves it locally.
+
+    Args:
+        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.
+    """
+    file_path = location / f"{filename}.yml"
+    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)
+
+        print(f"File downloaded and saved to {file_path}")
+
+    except requests.exceptions.HTTPError as http_err:
+        print(f"HTTP error occurred: {http_err}")
+    except Exception as err:
+        print(f"An error occurred: {err}")
+
+def build_default_library() -> NoReturn:
+    """
+    Downloads and saves the default materials from the specified URLs.
+    """
+    from PyOptik.utils import download_yml_file
+
+    for name, url in sellmeier_default.items():
+        download_yml_file(url=url, filename=name, location=sellmeier_data_path)
+
+    for name, url in tabulated_default.items():
+        download_yml_file(url=url, filename=name, location=tabulated_data_path)
+
+
+def remove_element(filename: str, location: str = 'any') -> None:
+    """
+    Remove a file associated with a given element name from the specified location.
+
+    Args:
+        filename (str): The name of the file to remove, without the '.yml' suffix.
+        location (str): The location to search for the file, either 'sellmeier', 'tabulated', or 'any' (default is 'any').
+
+    Raises:
+        FileNotFoundError: If the specified file does not exist.
+        ValueError: If an invalid location is provided.
+    """
+    location = location.lower()
+
+    if location not in ['any', 'sellmeier', 'tabulated']:
+        raise ValueError("Invalid location. Please choose 'sellmeier', 'tabulated', or 'any'.")
+
+    if location in ['any', 'sellmeier']:
+        sellmeier_file = sellmeier_data_path / f"{filename}.yml"
+        if sellmeier_file.exists():
+            sellmeier_file.unlink()
+
+    if location in ['any', 'tabulated']:
+        tabulated_file = tabulated_data_path / f"{filename}.yml"
+        if tabulated_file.exists():
+            tabulated_file.unlink()
+
+def create_sellmeier_file(
+    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) -> NoReturn:
+    """
+    Creates a YAML file with custom Sellmeier coefficients in the correct format.
+
+    Args:
+        filename (str): The name of the file to create (without the extension).
+        formula_type (int): The type of Sellmeier formula.
+        coefficients (list[float]): A list of coefficients for the Sellmeier equation.
+        wavelength_range (Tuple[float, float]): The range of wavelengths, in micrometers.
+        reference (str): A reference for the material data.
+        comments (Optional[str]): Additional comments about the material.
+        specs (Optional[dict]): Additional specifications, such as temperature and whether the wavelength is in a vacuum.
+    """
+    reference = 'None' if reference is None else reference
+    wavelength_range = [None, None] if wavelength_range is None else wavelength_range
+    # Create the data dictionary for YAML
+    data = {
+        'REFERENCES': reference,
+        'DATA': [
+            {
+                'type': f'formula {formula_type}',
+                'wavelength_range': f"{wavelength_range[0]} {wavelength_range[1]}",
+                'coefficients': " ".join(map(str, coefficients)),
+            }
+        ]
+    }
+
+    # Add comments if provided
+    if comments:
+        data['COMMENTS'] = comments
+
+    # Add specs if provided
+    if specs:
+        data['SPECS'] = specs
+
+    # Define the file path
+    file_path = sellmeier_data_path / f"{filename}.yml"
+
+    # Write the data to a YAML file
+    with open(file_path, 'w') as file:
+        yaml.dump(data, file, default_flow_style=False)
+
+    print(f"Sellmeier data saved to {file_path}")
+
+def create_tabulated_file(
+    filename: str,
+    data: List[Tuple[float, float, float]],
+    reference: Optional[str] = None,
+    comments: Optional[str] = None) -> NoReturn:
+    """
+    Creates a YAML file with tabulated nk data in the correct format.
+
+    Args:
+        filename (str): The name of the file to create (without the extension).
+        data (List[Tuple[float, float, float]]): The tabulated nk data.
+        reference (Optional[str]): A reference for the material data.
+        comments (Optional[str]): Additional comments about the material.
+    """
+    reference = 'None' if reference is None else reference
+
+    # Convert the data list to a formatted string
+    data_str = "\n".join(" ".join(map(str, row)) for row in data)
+
+    # Create the data dictionary for YAML
+    yaml_data = {
+        'REFERENCES': reference,
+        'DATA': [
+            {
+                'type': 'tabulated nk',
+                'data': data_str,
+            }
+        ]
+    }
+
+    # Add comments if provided
+    if comments:
+        yaml_data['COMMENTS'] = comments
+
+    # Define the file path
+    file_path = tabulated_data_path / f"{filename}.yml"
+
+    # Write the data to a YAML file
+    with open(file_path, 'w') as file:
+        yaml.dump(yaml_data, file, default_flow_style=False)
+
+    print(f"Tabulated nk data saved to {file_path}")

{pyoptik-1.3.1.post0 → pyoptik-1.4.0.post0}/PyOptik.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: PyOptik
-Version: 1.3.1.post0
+Version: 1.4.0.post0
 Summary: A package for refractive index values.
 Author-email: Martin Poinsinet de Sivry-Houle <martin.poinsinet.de.sivry@gmail.com>
 License: MIT License
@@ -28,10 +28,6 @@ License: MIT License
 Keywords: refracive index,optics
 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 :: 3.13
 Classifier: Programming Language :: Python :: Implementation :: CPython
 Classifier: Development Status :: 4 - Beta
 Classifier: Topic :: Scientific/Engineering :: Physics

{pyoptik-1.3.1.post0 → pyoptik-1.4.0.post0}/PyOptik.egg-info/SOURCES.txt

@@ -21,7 +21,6 @@ PyOptik.egg-info/dependency_links.txt
 PyOptik.egg-info/requires.txt
 PyOptik.egg-info/top_level.txt
 PyOptik/data/__init__.py
-PyOptik/data/test.yml
 PyOptik/data/sellmeier/BAK1.yml
 PyOptik/data/sellmeier/BK7.yml
 PyOptik/data/sellmeier/SF5.yml
@@ -56,6 +55,9 @@ docs/Makefile
 docs/make.bat
 docs/deprecated/experiment_material.py
 docs/examples/README.rst
+docs/examples/create_sellmeier_file.py
+docs/examples/create_tabulated_file.py
+docs/examples/download_yml_file.py
 docs/examples/plot_bk7.py
 docs/examples/plot_sf5.py
 docs/examples/plot_silica.py
@@ -72,11 +74,31 @@ docs/source/gallery/add_material.ipynb
 docs/source/gallery/add_material.py
 docs/source/gallery/add_material.rst
 docs/source/gallery/add_material_codeobj.pickle
+docs/source/gallery/create_sellmeier_file.ipynb
+docs/source/gallery/create_sellmeier_file.py
+docs/source/gallery/create_sellmeier_file.py.md5
+docs/source/gallery/create_sellmeier_file.rst
+docs/source/gallery/create_sellmeier_file_codeobj.pickle
+docs/source/gallery/create_tabulated_file.ipynb
+docs/source/gallery/create_tabulated_file.py
+docs/source/gallery/create_tabulated_file.py.md5
+docs/source/gallery/create_tabulated_file.rst
+docs/source/gallery/create_tabulated_file_codeobj.pickle
+docs/source/gallery/download_yml_file.ipynb
+docs/source/gallery/download_yml_file.py
+docs/source/gallery/download_yml_file.py.md5
+docs/source/gallery/download_yml_file.rst
+docs/source/gallery/download_yml_file_codeobj.pickle
 docs/source/gallery/get_values.ipynb
 docs/source/gallery/get_values.py
 docs/source/gallery/get_values.rst
 docs/source/gallery/get_values_codeobj.pickle
 docs/source/gallery/index.rst
+docs/source/gallery/plot_bk7.ipynb
+docs/source/gallery/plot_bk7.py
+docs/source/gallery/plot_bk7.py.md5
+docs/source/gallery/plot_bk7.rst
+docs/source/gallery/plot_bk7_codeobj.pickle
 docs/source/gallery/plot_sellmeier_0.ipynb
 docs/source/gallery/plot_sellmeier_0.py
 docs/source/gallery/plot_sellmeier_0.py.md5
@@ -87,13 +109,49 @@ docs/source/gallery/plot_sellmeier_1.py
 docs/source/gallery/plot_sellmeier_1.py.md5
 docs/source/gallery/plot_sellmeier_1.rst
 docs/source/gallery/plot_sellmeier_1_codeobj.pickle
+docs/source/gallery/plot_sf5.ipynb
+docs/source/gallery/plot_sf5.py
+docs/source/gallery/plot_sf5.py.md5
+docs/source/gallery/plot_sf5.rst
+docs/source/gallery/plot_sf5_codeobj.pickle
+docs/source/gallery/plot_silica.ipynb
+docs/source/gallery/plot_silica.py
+docs/source/gallery/plot_silica.py.md5
+docs/source/gallery/plot_silica.rst
+docs/source/gallery/plot_silica_codeobj.pickle
+docs/source/gallery/plot_silver.ipynb
+docs/source/gallery/plot_silver.py
+docs/source/gallery/plot_silver.py.md5
+docs/source/gallery/plot_silver.rst
+docs/source/gallery/plot_silver_codeobj.pickle
+docs/source/gallery/plot_water.ipynb
+docs/source/gallery/plot_water.py
+docs/source/gallery/plot_water.py.md5
+docs/source/gallery/plot_water.rst
+docs/source/gallery/plot_water_codeobj.pickle
 docs/source/gallery/sg_execution_times.rst
+docs/source/gallery/images/sphx_glr_create_sellmeier_file_001.png
+docs/source/gallery/images/sphx_glr_create_tabulated_file_001.png
+docs/source/gallery/images/sphx_glr_download_yml_file_001.png
+docs/source/gallery/images/sphx_glr_plot_bk7_001.png
 docs/source/gallery/images/sphx_glr_plot_sellmeier_0_001.png
 docs/source/gallery/images/sphx_glr_plot_sellmeier_1_001.png
+docs/source/gallery/images/sphx_glr_plot_sf5_001.png
+docs/source/gallery/images/sphx_glr_plot_silica_001.png
+docs/source/gallery/images/sphx_glr_plot_silver_001.png
+docs/source/gallery/images/sphx_glr_plot_water_001.png
 docs/source/gallery/images/thumb/sphx_glr_add_material_thumb.png
+docs/source/gallery/images/thumb/sphx_glr_create_sellmeier_file_thumb.png
+docs/source/gallery/images/thumb/sphx_glr_create_tabulated_file_thumb.png
+docs/source/gallery/images/thumb/sphx_glr_download_yml_file_thumb.png
 docs/source/gallery/images/thumb/sphx_glr_get_values_thumb.png
+docs/source/gallery/images/thumb/sphx_glr_plot_bk7_thumb.png
 docs/source/gallery/images/thumb/sphx_glr_plot_sellmeier_0_thumb.png
 docs/source/gallery/images/thumb/sphx_glr_plot_sellmeier_1_thumb.png
+docs/source/gallery/images/thumb/sphx_glr_plot_sf5_thumb.png
+docs/source/gallery/images/thumb/sphx_glr_plot_silica_thumb.png
+docs/source/gallery/images/thumb/sphx_glr_plot_silver_thumb.png
+docs/source/gallery/images/thumb/sphx_glr_plot_water_thumb.png
 tests/__init__.py
 tests/test_sellmeier.py
 tests/test_tabulated.py

pyoptik-1.4.0.post0/docs/examples/create_sellmeier_file.py

@@ -0,0 +1,32 @@
+"""
+Example: Create a Custom Sellmeier YAML File
+============================================
+
+This example demonstrates how to create a custom Sellmeier YAML file using the
+`create_sellmeier_file` function from the `PyOptik.utils` module.
+"""
+
+from PyOptik.utils import create_sellmeier_file
+from PyOptik.directories import sellmeier_data_path
+from PyOptik import SellmeierMaterial
+
+# Define the file properties
+filename = 'example_sellmeier'
+coefficients = [1.0, 0.5, 0.2, 0.1, 0.05]
+formula_type = 1
+
+# Call the function to create the file
+create_sellmeier_file(
+    filename=filename,
+    coefficients=coefficients,
+    formula_type=formula_type,
+    wavelength_range=(0.2, 2.0),
+    reference="Sample Reference",
+    comments="This is a sample Sellmeier file created for demonstration purposes."
+)
+
+print(f"Sellmeier YAML file {filename}.yml has been created in {sellmeier_data_path}")
+
+m = SellmeierMaterial(filename)
+
+m.plot()

pyoptik-1.4.0.post0/docs/examples/create_tabulated_file.py

@@ -0,0 +1,39 @@
+"""
+Example: Create a Custom Tabulated Data YAML File
+=================================================
+
+This example demonstrates how to create a custom YAML file containing tabulated
+`nk` data using the `create_tabulated_file` function from the `PyOptik.utils` module.
+"""
+
+from PyOptik.utils import create_tabulated_file
+from PyOptik.directories import tabulated_data_path
+from PyOptik import TabulatedMaterial
+
+# Define the tabulated data (wavelength in micrometers, n, k)
+tabulated_data = [
+    (0.1879, 0.94, 1.337),
+    (0.1916, 0.95, 1.388),
+    (0.1953, 0.97, 1.440),
+    (0.1993, 0.98, 1.493),
+    (0.2033, 0.99, 1.550),
+]
+
+# Define the file properties
+filename = 'example_tabulated'
+reference = "Example Reference for Tabulated Data"
+comments = "This file contains sample tabulated data for demonstration purposes. "
+
+# Call the function to create the file
+create_tabulated_file(
+    filename=filename,
+    data=tabulated_data,
+    reference=reference,
+    comments=comments
+)
+
+print(f"Tabulated YAML file {filename}.yml has been created in {tabulated_data_path}")
+
+m = TabulatedMaterial(filename)
+
+m.plot()

pyoptik-1.4.0.post0/docs/examples/download_yml_file.py

@@ -0,0 +1,22 @@
+"""
+Example: Download a YAML file
+=============================
+
+This example demonstrates how to download a YAML file from a URL using the
+`download_yml_file` function from the `PyOptik.utils` module.
+"""
+
+from PyOptik.utils import download_yml_file
+from PyOptik.directories import sellmeier_data_path
+from PyOptik import SellmeierMaterial
+
+# Define the URL of the YAML file and the destination
+url = 'https://refractiveindex.info/database/data-nk/main/H2O/Daimon-19.0C.yml'
+filename = 'example_download'
+
+# Call the function to download the file
+download_yml_file(filename=filename, url=url, location=sellmeier_data_path)
+
+m = SellmeierMaterial('example_download')
+
+m.plot()

pyoptik-1.4.0.post0/docs/source/code.rst

@@ -0,0 +1,60 @@
+:orphan:
+
+.. _source_code:
+
+Source Code Documentation
+=========================
+
+This section provides an overview of the key classes and functions within the `PyOptik` library, including the `Sellmeier` class. Detailed documentation of each component is generated automatically, showing all available members, inherited members, and their corresponding source code.
+
+Class Documentation
+===================
+
+Below, you'll find automatically generated documentation for other significant classes and functions in the `PyOptik` library.
+
+.. _sellmeier_material:
+
+SellmeierMaterial
+-----------------
+
+The `SellmeierMaterial` class extends the `Material` base class to specifically handle materials described by the Sellmeier equation.
+
+.. autoclass:: PyOptik.SellmeierMaterial
+    :members:
+    :inherited-members:
+    :member-order: bysource
+    :show-inheritance:
+    :undoc-members:
+
+
+TabulatedMaterial
+-----------------
+
+The `TabulatedMaterial` class extends the `Material` base class to specifically handle materials described by the tabulated values.
+
+.. autoclass:: PyOptik.TabulatedMaterial
+    :members:
+    :inherited-members:
+    :member-order: bysource
+    :show-inheritance:
+    :undoc-members:
+
+Utility Functions
+-----------------
+
+The `PyOptik.utils` module contains utility functions that assist with tasks like downloading data files, creating custom materials, and managing directories.
+
+.. automodule:: PyOptik.utils
+    :members:
+    :undoc-members:
+    :show-inheritance:
+    :member-order: bysource
+
+Directives for Sphinx Gallery
+=============================
+
+The following are directives for integrating code examples using Sphinx Gallery:
+
+.. note::
+    You can find example usage of the `SellmeierMaterial` and `TabulatedMaterial` classes, along with utility functions, in the "Examples" section of the documentation. These examples are automatically generated from the code and illustrate practical applications of the library.
+

{pyoptik-1.3.1.post0 → pyoptik-1.4.0.post0}/docs/source/conf.py

@@ -50,6 +50,7 @@ sphinx_gallery_conf = {
     'gallery_dirs': 'gallery',
     'image_scrapers': ('matplotlib'),
     'ignore_pattern': '/__',
+    'filename_pattern': r'.*\.py',
     'plot_gallery': True,
     'thumbnail_size': [600, 600],
     'download_all_examples': False,

pyoptik-1.4.0.post0/docs/source/gallery/create_sellmeier_file.ipynb

@@ -0,0 +1,43 @@
+{
+  "cells": [
+    {
+      "cell_type": "markdown",
+      "metadata": {},
+      "source": [
+        "\n# Example: Create a Custom Sellmeier YAML File\n\nThis example demonstrates how to create a custom Sellmeier YAML file using the\n`create_sellmeier_file` function from the `PyOptik.utils` module.\n"
+      ]
+    },
+    {
+      "cell_type": "code",
+      "execution_count": null,
+      "metadata": {
+        "collapsed": false
+      },
+      "outputs": [],
+      "source": [
+        "from PyOptik.utils import create_sellmeier_file\nfrom PyOptik.directories import sellmeier_data_path\nfrom PyOptik import SellmeierMaterial\n\n# Define the file properties\nfilename = 'example_sellmeier'\ncoefficients = [1.0, 0.5, 0.2, 0.1, 0.05]\nformula_type = 1\n\n# Call the function to create the file\ncreate_sellmeier_file(\n    filename=filename,\n    coefficients=coefficients,\n    formula_type=formula_type,\n    wavelength_range=(0.2, 2.0),\n    reference=\"Sample Reference\",\n    comments=\"This is a sample Sellmeier file created for demonstration purposes.\"\n)\n\nprint(f\"Sellmeier YAML file {filename}.yml has been created in {sellmeier_data_path}\")\n\nm = SellmeierMaterial('example_download')\n\nm.plot()"
+      ]
+    }
+  ],
+  "metadata": {
+    "kernelspec": {
+      "display_name": "Python 3",
+      "language": "python",
+      "name": "python3"
+    },
+    "language_info": {
+      "codemirror_mode": {
+        "name": "ipython",
+        "version": 3
+      },
+      "file_extension": ".py",
+      "mimetype": "text/x-python",
+      "name": "python",
+      "nbconvert_exporter": "python",
+      "pygments_lexer": "ipython3",
+      "version": "3.11.0"
+    }
+  },
+  "nbformat": 4,
+  "nbformat_minor": 0
+}

pyoptik-1.4.0.post0/docs/source/gallery/create_sellmeier_file.py

@@ -0,0 +1,32 @@
+"""
+Example: Create a Custom Sellmeier YAML File
+============================================
+
+This example demonstrates how to create a custom Sellmeier YAML file using the
+`create_sellmeier_file` function from the `PyOptik.utils` module.
+"""
+
+from PyOptik.utils import create_sellmeier_file
+from PyOptik.directories import sellmeier_data_path
+from PyOptik import SellmeierMaterial
+
+# Define the file properties
+filename = 'example_sellmeier'
+coefficients = [1.0, 0.5, 0.2, 0.1, 0.05]
+formula_type = 1
+
+# Call the function to create the file
+create_sellmeier_file(
+    filename=filename,
+    coefficients=coefficients,
+    formula_type=formula_type,
+    wavelength_range=(0.2, 2.0),
+    reference="Sample Reference",
+    comments="This is a sample Sellmeier file created for demonstration purposes."
+)
+
+print(f"Sellmeier YAML file {filename}.yml has been created in {sellmeier_data_path}")
+
+m = SellmeierMaterial('example_download')
+
+m.plot()

pyoptik-1.4.0.post0/docs/source/gallery/create_sellmeier_file.py.md5

@@ -0,0 +1 @@
+b9a236b8d62b0a4224483ca056ab4775