PyFiberModes 0.7.0__tar.gz → 0.7.2__tar.gz

{pyfibermodes-0.7.0 → pyfibermodes-0.7.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: PyFiberModes
-Version: 0.7.0
+Version: 0.7.2
 Summary: A package for light propagation in fiber optics.
 Author-email: Martin Poinsinet de Sivry-Houle <martin.poinsinet.de.sivry@gmail.com>
 License:                     GNU GENERAL PUBLIC LICENSE
@@ -711,7 +711,6 @@ Requires-Dist: pydata-sphinx-theme==0.14.1; extra == "documentation"
 Provides-Extra: dev
 Requires-Dist: flake8==7.1.1; extra == "dev"
 
-
 .. list-table::
    :widths: 10 25 25
    :header-rows: 0
@@ -733,49 +732,56 @@ Requires-Dist: flake8==7.1.1; extra == "dev"
 PyFiberModes
 ============
 
-A numerical tool for simulating propagating modes in fiber optics, supporting all kinds of circular-symmetric geometries.
+PyFiberModes is a Python package designed to simulate the propagation of modes in optical fibers. It supports all circularly symmetric geometries and provides tools for in-depth analysis of optical fiber properties and modal characteristics.
 
+Key Features
+------------
+- **Comprehensive Simulations**: Supports step-index fibers, multilayer fibers, and custom refractive index profiles.
+- **Extensive Mode Analysis**: Calculate mode profiles, propagation constants, effective indices, and more.
+- **Open Source**: Designed for customization and extensibility.
 
 ----
 
 Documentation
 **************
-The latest documentation is available `here <https://martinpdes.github.io/PyFiberModes/>`_ or by clicking the badge below:
+The latest documentation is always available `here <https://martinpdes.github.io/PyFiberModes/>`_ or via the badge below:
 
 |docs|
 
-
 ----
 
 
 Installation
 ************
 
-Pip Installation
-================
-PyFiberModes is available as a Python wheel for Linux and macOS. It requires Python 3.10. To install, simply run:
+Using Pip
+---------
+
+Install the PyFiberModes package directly from PyPi. Ensure you have Python 3.10 or later:
 
 .. code-block:: bash
 
    pip install PyFiberModes
 
+
 Manual Installation
-===================
-For manual installation, clone the repository and install dependencies:
+-------------------
+
+To manually install the package:
 
 .. code-block:: bash
 
    git clone https://github.com/MartinPdeS/PyFiberModes.git
    cd PyFiberModes
-   pip install -r requirements/requirements.txt
    pip install .
 
+
 ----
 
 Testing
 *******
 
-To run tests locally after cloning the repository, follow these steps:
+PyFiberModes includes comprehensive tests. To run the tests locally:
 
 .. code-block:: bash
 
@@ -785,20 +791,31 @@ To run tests locally after cloning the repository, follow these steps:
    coverage run --source=PyFiberModes --module pytest --verbose tests
    coverage report --show-missing
 
-This ensures the package is thoroughly tested and provides a coverage report.
+
+This will generate a coverage report detailing untested portions of the code.
 
 ----
 
-Coding Examples
-***************
-Explore plenty of examples in the `examples section <https://martinpdes.github.io/PyFiberModes/docs/v0.5.9.3/gallery/index.html>`_ of the documentation.
+
+Examples and Usage
+******************
+Learn how to use PyFiberModes with detailed examples in the `Examples Section <https://martinpdes.github.io/PyFiberModes>`_ of the documentation. Examples include:
+- Calculating the effective index for a given mode.
+- Visualizing mode profiles in optical fibers.
+- Evaluating fiber parameters like V-number and dispersion.
 
 ----
 
+Get Involved
+************
+PyFiberModes is an actively maintained project, and contributions are highly encouraged! Whether it's a bug fix, feature request, or enhancement, your input is valuable.
+
+- Report issues or request features on the `GitHub Issue Tracker <https://github.com/MartinPdeS/PyFiberModes/issues>`_.
+- Open pull requests to improve the codebase.
+
 Contact
 *******
-
-PyFiberModes is actively developed, and contributions are welcome! If you'd like to collaborate or provide feedback, please reach out.
+If you would like to collaborate, please reach out:
 
 Author: `Martin Poinsinet de Sivry-Houle <https://github.com/MartinPdS>`_
 

{pyfibermodes-0.7.0 → pyfibermodes-0.7.2}/PyFiberModes/__init__.py

@@ -1,4 +1,3 @@
-from PyFiberModes.wavelength import Wavelength
 from PyFiberModes.mode import Mode, Family  # noqa: F401
 from PyFiberModes.mode_instances import *  # noqa: F403
 from PyFiberModes.factory import FiberFactory

{pyfibermodes-0.7.0 → pyfibermodes-0.7.2}/PyFiberModes/_version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '0.7.0'
-__version_tuple__ = version_tuple = (0, 7, 0)
+__version__ = version = '0.7.2'
+__version_tuple__ = version_tuple = (0, 7, 2)

{pyfibermodes-0.7.0 → pyfibermodes-0.7.2}/PyFiberModes/coordinates.py

@@ -1,6 +1,6 @@
 import numpy as np
 from dataclasses import dataclass
-from typing import Tuple, Self
+from typing import Tuple
 
 
 @dataclass
@@ -34,7 +34,7 @@ class CylindricalCoordinates:
         y = self.rho * np.sin(self.phi)
         return CartesianCoordinates(x=x, y=y, z=self.z)
 
-    def to_cylindrical(self) -> Self:
+    def to_cylindrical(self):
         """
         Returns self in cylindrical format (no conversion needed).
 
@@ -116,10 +116,28 @@ class CartesianCoordinates:
         """
         if self.is_structured:
             x_min, x_max = self.x_boundaries
-            return (x_max - x_min) / self.n_x
+            return (x_max - x_min) / len(self.x)
         raise ValueError("dx value cannot be inferred from an unstructured mesh.")
 
-    # Similar implementations for dy and dz...
+    @property
+    def dy(self) -> float:
+        """
+        Calculates the grid spacing in the x-direction.
+
+        Returns
+        -------
+        float
+            Grid spacing in the x-direction.
+
+        Raises
+        ------
+        ValueError
+            If the mesh is unstructured.
+        """
+        if self.is_structured:
+            y_min, y_max = self.y_boundaries
+            return (y_max - y_min) / len(self.y)
+        raise ValueError("dx value cannot be inferred from an unstructured mesh.")
 
     @classmethod
     def generate_from_boundaries(cls, x_limits, y_limits, z_limits, x_points, y_points, z_points) -> 'CartesianCoordinates':
@@ -166,25 +184,15 @@ class CartesianCoordinates:
         length : float
             The length of the square's side.
         center : Tuple[float, float], optional
-            The coordinates of the square's center (x0, y0).
-            Default is (0.0, 0.0).
+            The coordinates of the square's center (x0, y0). Default is (0.0, 0.0).
         n_points : int, optional
-            The number of points along each dimension (x, y).
-            Default is 100.
+            The number of points along each dimension (x, y). Default is 100.
 
         Returns
         -------
         CartesianCoordinates
             Cartesian coordinate system with x, y mesh grids and z set to 0.
 
-        Examples
-        --------
-        >>> coords = CartesianCoordinates.generate_from_square(
-        ...     length=2.0, center=(1.0, 1.0), n_points=10)
-        >>> coords.x.shape
-        (10, 10)
-        >>> coords.y.shape
-        (10, 10)
         """
         x0, y0 = center
 
@@ -232,7 +240,7 @@ class CartesianCoordinates:
         phi = np.arctan2(self.y, self.x)
         return CylindricalCoordinates(rho=rho, phi=phi, z=self.z)
 
-    def shift_coordinates(self, shift: Tuple[float, float, float]) -> Self:
+    def shift_coordinates(self, shift: Tuple[float, float, float]):
         """
         Shifts the coordinates by specified amounts.
 

{pyfibermodes-0.7.0/PyFiberModes/tools → pyfibermodes-0.7.2/PyFiberModes}/directories.py

@@ -9,9 +9,7 @@ __all__ = [
     'root_path',
     'project_path',
     'examples_path',
-    'version_path',
     'doc_path',
-    # 'logo_path',
     'doc_css_path',
 ]
 
@@ -19,8 +17,6 @@ root_path = Path(PyFiberModes.__path__[0])
 
 project_path = root_path.parents[0]
 
-version_path = root_path.joinpath('VERSION')
-
 doc_path = project_path.joinpath('docs')
 
 examples_path = doc_path.joinpath('examples')
@@ -29,13 +25,8 @@ logo_path = doc_path.joinpath('images/logo.png')
 
 doc_css_path = doc_path.joinpath('source/_static/default.css')
 
-rtd_example = 'https://pyfinitdiff.readthedocs.io/en/latest/Examples.html'
-
-
 if __name__ == '__main__':
     for path_name in __all__:
         path = locals()[path_name]
         print(path)
         assert path.exists(), f"Path {path_name} do not exists"
-
-# -

pyfibermodes-0.7.2/PyFiberModes/factory.py

@@ -0,0 +1,148 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+from itertools import product
+from dataclasses import dataclass, field
+import numpy as np
+from PyFiberModes.fiber import Fiber
+
+
+@dataclass
+class ProxyLayer:
+    """
+    Represents a layer configuration in a fiber, with name, radius, and refractive index.
+
+    Attributes
+    ----------
+    name : str
+        Name of the layer.
+    radius : list[float]
+        Radius values for the layer (in meters).
+    index : list[float]
+        Refractive index values for the layer.
+    """
+    name: str
+    radius: list = field(default_factory=list)
+    index: list = field(default_factory=list)
+
+    def __post_init__(self):
+        self.name = [self.name]
+        self.radius = np.atleast_1d(self.radius)
+        self.index = np.atleast_1d(self.index)
+
+    def get_generator(self):
+        """
+        Create a generator for all combinations of name, radius, and index.
+
+        Returns
+        -------
+        generator : itertools.product
+            Generator yielding tuples of (name, radius, index).
+        """
+        return product(self.name, self.radius, self.index)
+
+
+class FiberFactory:
+    """
+    Factory to create and manage multiple Fiber instances with various configurations.
+
+    Parameters
+    ----------
+    wavelength : float
+        Wavelength (in meters) used for fiber simulations.
+
+    Attributes
+    ----------
+    layers_list : list[ProxyLayer]
+        List of ProxyLayer objects representing the layers of the fiber.
+    neff_solver : None
+        Placeholder for a solver object (if required).
+    cutoff_solver : None
+        Placeholder for a cutoff solver object (if required).
+    wavelength : float
+        Wavelength used in simulations.
+    """
+
+    def __init__(self, wavelength: float):
+        self.layers_list = []
+        self.neff_solver = None
+        self.cutoff_solver = None
+        self.wavelength = wavelength
+
+    def add_layer(self, index: float, name: str = "", radius: float = 0.0):
+        """
+        Add a new layer to the fiber factory.
+
+        Parameters
+        ----------
+        index : float
+            Refractive index of the layer.
+        name : str, optional
+            Name of the layer (default is an empty string).
+        radius : float, optional
+            Radius of the layer (default is 0.0 meters).
+        """
+        layer = ProxyLayer(name=name, radius=radius, index=index)
+        self.layers_list.append(layer)
+
+    def get_overall_generator(self):
+        """
+        Generate all possible combinations of layer configurations.
+
+        Returns
+        -------
+        overall_generator : itertools.product
+            Generator yielding all possible layer configurations.
+        """
+        generators = [layer.get_generator() for layer in self.layers_list]
+        return product(*generators)
+
+    def __getitem__(self, index: int) -> Fiber:
+        """
+        Retrieve a specific fiber configuration by index.
+
+        Parameters
+        ----------
+        index : int
+            Index of the desired fiber configuration.
+
+        Returns
+        -------
+        fiber : Fiber
+            A Fiber object with the selected configuration.
+        """
+        structure = list(self.get_overall_generator())[index]
+        fiber = self._create_fiber_from_structure(structure)
+        return fiber
+
+    def __iter__(self):
+        """
+        Iterate through all possible fiber configurations.
+
+        Yields
+        ------
+        fiber : Fiber
+            A Fiber object with the next configuration in the sequence.
+        """
+        for structure in self.get_overall_generator():
+            yield self._create_fiber_from_structure(structure)
+
+    def _create_fiber_from_structure(self, structure) -> Fiber:
+        """
+        Create a Fiber object from a given structure.
+
+        Parameters
+        ----------
+        structure : iterable
+            An iterable containing tuples of (name, radius, index) for each layer.
+
+        Returns
+        -------
+        fiber : Fiber
+            A Fiber object initialized with the given structure.
+        """
+        fiber = Fiber(wavelength=self.wavelength)
+        for name, radius, index in structure:
+            fiber.add_layer(name=name, radius=radius, index=index)
+        fiber.initialize_layers()
+        return fiber