PyOptik 1.6.3.post0__tar.gz → 1.6.5.post0__tar.gz

{pyoptik-1.6.3.post0 → pyoptik-1.6.5.post0}/.github/workflows/deploy_anaconda.yml

@@ -31,4 +31,4 @@ jobs:
           ANACONDA_API_TOKEN: ${{ secrets.ANACONDA_API_TOKEN }}  # Ensure the Anaconda token is set
         run: |
           conda install conda-build anaconda-client conda-verify -y
-          conda build .
+          conda build . -c martinpdes

{pyoptik-1.6.3.post0 → pyoptik-1.6.5.post0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: PyOptik
-Version: 1.6.3.post0
+Version: 1.6.5.post0
 Summary: A package for refractive index values.
 Author-email: Martin Poinsinet de Sivry-Houle <martin.poinsinet.de.sivry@gmail.com>
 License: MIT License
@@ -69,7 +69,7 @@ PyOptik is a powerful Python tool designed to import refractive indexes and exti
    :header-rows: 1
 
    * - Testing
-     -
+     - |ci/cd|
      - |coverage|
      -
    * - Package
@@ -199,6 +199,10 @@ As of 2024, PyOptik is still under development. If you would like to collaborate
    :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
    :target: https://badge.fury.io/py/pyoptik
 

{pyoptik-1.6.3.post0 → pyoptik-1.6.5.post0}/PyOptik/_version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '1.6.3.post0'
-__version_tuple__ = version_tuple = (1, 6, 3)
+__version__ = version = '1.6.5.post0'
+__version_tuple__ = version_tuple = (1, 6, 5)

{pyoptik-1.6.3.post0 → pyoptik-1.6.5.post0}/PyOptik/base_class.py

@@ -6,8 +6,10 @@ class BaseMaterial:
         """
         Provides an informal string representation of the Material object.
 
-        Returns:
-            str: Informal representation of the Material object.
+        Returns
+        -------
+        str
+            Informal representation of the Material object.
         """
         return f"Material: {self.filename}"
 
@@ -15,7 +17,9 @@ class BaseMaterial:
         """
         Provides a formal string representation of the Material object, including key attributes.
 
-        Returns:
-            str: Formal representation of the Material object.
+        Returns
+        -------
+        str
+            Formal representation of the Material object.
         """
         return self.__str__()

{pyoptik-1.6.3.post0 → pyoptik-1.6.5.post0}/PyOptik/material.py

@@ -45,14 +45,20 @@ class Material:
         """
         Retrieve a material by name.
 
-        Args:
-            material_name (str): The name of the material to retrieve.
+        Parameters
+        ----------
+        material_name : str
+            The name of the material to retrieve.
 
-        Returns:
-            Union[SellmeierMaterial, TabulatedMaterial]: An instance of the material if found.
+        Returns
+        -------
+        Union[SellmeierMaterial, TabulatedMaterial]
+            An instance of the material if found.
 
-        Raises:
-            FileNotFoundError: If the material is not found in either the Sellmeier or Tabulated lists.
+        Raises
+        ------
+        FileNotFoundError
+            If the material is not found in either the Sellmeier or Tabulated lists.
         """
         if material_name in data.sellmeier.material_list:
             return SellmeierMaterial(material_name)

{pyoptik-1.6.3.post0 → pyoptik-1.6.5.post0}/PyOptik/sellmeier_class.py

@@ -64,11 +64,14 @@ class SellmeierMaterial(BaseMaterial):
         """
         Checks if a wavelength is within the material's allowable range and raises an error if it is not.
 
-        Args:
+        Parameters
+        ----------
             wavelength (float): The wavelength to check in meters.
 
-        Raises:
-            ValueError: If the wavelength is outside the allowable range.
+        Raises
+        ------
+        ValueError
+            If the wavelength is outside the allowable range.
         """
         if self.wavelength_range is not None:
             min_value, max_value = self.wavelength_range
@@ -79,14 +82,20 @@ class SellmeierMaterial(BaseMaterial):
         """
         Computes the refractive index n(λ) using the appropriate formula (either Formula 1 or Formula 2).
 
-        Args:
-            wavelength (Union[float, numpy.ndarray]): The wavelength λ in meters, can be a single float or a numpy array.
+        Parameters
+        ----------
+        wavelength : Union[float, numpy.ndarray])
+            The wavelength λ in meters, can be a single float or a numpy array.
 
-        Returns:
-            Union[float, numpy.ndarray]: The refractive index n(λ) for the given wavelength or array of wavelengths.
+        Returns
+        -------
+        Union[float, numpy.ndarray]
+            The refractive index n(λ) for the given wavelength or array of wavelengths.
 
-        Raises:
-            ValueError: If the wavelength is outside the specified range or if an unsupported formula type is encountered.
+        Raises
+        ------
+        ValueError
+            If the wavelength is outside the specified range or if an unsupported formula type is encountered.
         """
         # Ensure that wavelength is within the allowable range if it's a single value
         wavelength = numpy.atleast_1d(wavelength)
@@ -139,8 +148,10 @@ class SellmeierMaterial(BaseMaterial):
         """
         Plots the refractive index as a function of wavelength over a specified range.
 
-        Args:
-            wavelength_range (Union[List[float], numpy.ndarray]): The range of wavelengths to plot, in meters.
+        Parameters
+        ----------
+        wavelength_range : Union[List[float], numpy.ndarray]
+            The range of wavelengths to plot, in meters.
         """
         with plt.style.context(mps):
             if wavelength is None:
@@ -168,8 +179,10 @@ class SellmeierMaterial(BaseMaterial):
         """
         Provides a formal string representation of the Material object, including key attributes.
 
-        Returns:
-            str: Formal representation of the Material object.
+        Returns
+        -------
+        str
+            Formal representation of the Material object.
         """
         return (
             f"\nMaterial: '{self.filename}',\n"

{pyoptik-1.6.3.post0 → pyoptik-1.6.5.post0}/PyOptik/tabulated_class.py

@@ -56,14 +56,19 @@ class TabulatedMaterial(BaseMaterial):
         """
         Interpolates the refractive index (n) and absorption (k) values for the given wavelength(s).
 
-        Args:
+        Parameters
+        ----------
             wavelength (Union[float, numpy.ndarray]): Wavelength(s) in micrometers for which to interpolate n and k.
 
-        Returns:
-            Tuple[numpy.ndarray, numpy.ndarray]: Interpolated refractive index (n) and absorption (k) values.
+        Returns
+        -------
+        Tuple[numpy.ndarray, numpy.ndarray]
+            Interpolated refractive index (n) and absorption (k) values.
 
-        Raises:
-            ValueError: If the wavelength is outside the tabulated range.
+        Raises
+        ------
+        ValueError
+            If the wavelength is outside the tabulated range.
         """
         wavelength = numpy.asarray(wavelength)
 
@@ -111,8 +116,10 @@ class TabulatedMaterial(BaseMaterial):
         """
         Provides a formal string representation of the TabulatedMaterial object, including key attributes.
 
-        Returns:
-            str: Formal representation of the TabulatedMaterial object.
+        Returns
+        -------
+        str
+            Formal representation of the TabulatedMaterial object.
         """
         return (
             f"\nTabulatedMaterial: '{self.filename}',\n"

{pyoptik-1.6.3.post0 → pyoptik-1.6.5.post0}/PyOptik.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: PyOptik
-Version: 1.6.3.post0
+Version: 1.6.5.post0
 Summary: A package for refractive index values.
 Author-email: Martin Poinsinet de Sivry-Houle <martin.poinsinet.de.sivry@gmail.com>
 License: MIT License
@@ -69,7 +69,7 @@ PyOptik is a powerful Python tool designed to import refractive indexes and exti
    :header-rows: 1
 
    * - Testing
-     -
+     - |ci/cd|
      - |coverage|
      -
    * - Package
@@ -199,6 +199,10 @@ As of 2024, PyOptik is still under development. If you would like to collaborate
    :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
    :target: https://badge.fury.io/py/pyoptik
 

{pyoptik-1.6.3.post0 → pyoptik-1.6.5.post0}/README.rst

@@ -10,7 +10,7 @@ PyOptik is a powerful Python tool designed to import refractive indexes and exti
    :header-rows: 1
 
    * - Testing
-     -
+     - |ci/cd|
      - |coverage|
      -
    * - Package
@@ -140,6 +140,10 @@ As of 2024, PyOptik is still under development. If you would like to collaborate
    :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
    :target: https://badge.fury.io/py/pyoptik
 

{pyoptik-1.6.3.post0 → pyoptik-1.6.5.post0}/docs/source/conf.py

@@ -22,7 +22,6 @@ autodoc_mock_imports = [
     'matplotlib',
     'scipy'
     'numpydoc',
-    'MPSPlots',
 ]
 
 
@@ -36,10 +35,19 @@ version = PyOptik.__version__
 
 extensions = [
     'sphinx.ext.mathjax',
-    'numpydoc',
+    'pyvista.ext.plot_directive',
     'sphinx_gallery.gen_gallery',
+    'sphinx.ext.autodoc',
+    'sphinx.ext.napoleon',
+    'sphinx.ext.viewcode',
+    'sphinx.ext.autosectionlabel',
+    'sphinx.ext.intersphinx',
 ]
 
+# Napoleon settings for docstrings
+napoleon_google_docstring = False
+napoleon_numpy_docstring = True
+
 
 def reset_mpl(gallery_conf, fname):
     use_mpsplots_style()

{pyoptik-1.6.3.post0 → pyoptik-1.6.5.post0}/meta.yaml

@@ -3,6 +3,7 @@ package:
   version: {{ GIT_DESCRIBE_TAG }}
 
 source:
+  path: ../
   git_url: https://github.com/MartinPdeS/PyOptik.git
 
 build:
@@ -10,6 +11,10 @@ build:
   script: {{ PYTHON }} -m pip install . -vv --no-deps --no-build-isolation
   number: 0
 
+channels:
+  - conda-forge
+  - martinpdes
+
 requirements:
   host:
     - python >=3.8

{pyoptik-1.6.3.post0 → pyoptik-1.6.5.post0}/pyproject.toml

@@ -32,7 +32,9 @@ dependencies = [
 ]
 
 [tool.setuptools]
-packages = ["PyOptik"]
+packages = {find = {where = ["."], include = ["PyOptik*"]}}
+include-package-data = true
+
 
 [tool.setuptools_scm]
 write_to = "PyOptik/_version.py"