PyFiberModes 0.13.1__tar.gz → 0.14.0__tar.gz

{pyfibermodes-0.13.1 → pyfibermodes-0.14.0}/.github/workflows/quality.yml

@@ -19,4 +19,5 @@ jobs:
           python-version: "3.11"
       - run: python -m pip install --upgrade pip && python -m pip install -e ".[dev]"
       - run: python -m ruff check PyFiberModes tests tools
+      - run: python -m mypy
       - run: python tools/check_release.py

{pyfibermodes-0.13.1 → pyfibermodes-0.14.0}/.github/workflows/tests.yml

@@ -16,7 +16,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: ["3.10", "3.11", "3.12", "3.13"]
+        python-version: ["3.11", "3.12", "3.13"]
     steps:
       - uses: actions/checkout@fbc6f3992d24b796d5a048ff273f7fcc4a7b6c09
       - uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1

{pyfibermodes-0.13.1 → pyfibermodes-0.14.0}/.zenodo.json

@@ -1,6 +1,6 @@
 {
   "title": "PyFiberModes: guided-mode analysis and design for optical fibers",
-  "description": "PyFiberModes solves guided modes in circularly symmetric step-index and multilayer optical fibers, including field analysis, modal sweeps, inverse design, and coupled-mode propagation.",
+  "description": "Guided-mode analysis and design for circular optical fibers, with field analysis, dispersion, modal sweeps, inverse design, and coupled-mode propagation.",
   "creators": [
     {
       "name": "Poinsinet de Sivry-Houle, Martin"
@@ -9,11 +9,14 @@
   "license": "MIT",
   "upload_type": "software",
   "access_right": "open",
-  "version": "0.13.1",
-  "publication_date": "2026-09-22",
+  "version": "0.14.0",
+  "publication_date": "2026-09-23",
   "keywords": [
     "optical fibers",
     "guided modes",
+    "mode solver",
+    "optical waveguides",
+    "photonics",
     "effective index",
     "dispersion",
     "coupled-mode theory"

{pyfibermodes-0.13.1 → pyfibermodes-0.14.0}/CHANGELOG.md

@@ -6,6 +6,33 @@ use [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
 
+## [0.14.0] - 2026-09-23
+
+### Added
+
+- Expanded the specialty-fiber, field, analysis, validation, and performance
+  galleries so every documentation series contains multiple examples.
+- Defined a stable root-level public API, compatibility and deprecation policy,
+  API snapshot regression test, and migration guide.
+
+### Changed
+
+- Replaced the opaque `ssif`, `tlsif`, `mlsif`, and `NeffSolver` names with
+  descriptive two-layer, three-layer, multilayer, and effective-index solver
+  namespaces and class names.
+
+## [0.13.2] - 2026-09-23
+
+### Changed
+
+- Raised the minimum supported Python version to 3.11 and aligned CI,
+  contributor guidance, Ruff, and Conda metadata with that policy.
+- Moved Matplotlib rendering into the optional `PyFiberModes.plotting` module
+  and added the `plotting` installation extra, keeping it out of core runtime
+  dependencies while preserving the `Field.plot` convenience method.
+- Replaced generic package descriptions and keywords with fiber-mode,
+  photonics, waveguide, dispersion, and coupled-mode metadata.
+
 ## [0.13.1] - 2026-09-22
 
 ### Added
@@ -74,7 +101,9 @@ use [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 - Established the current tagged baseline for subsequent documented releases.
 
-[Unreleased]: https://github.com/MartinPdeS/PyFiberModes/compare/v0.13.1...HEAD
+[Unreleased]: https://github.com/MartinPdeS/PyFiberModes/compare/v0.14.0...HEAD
+[0.14.0]: https://github.com/MartinPdeS/PyFiberModes/releases/tag/v0.14.0
+[0.13.2]: https://github.com/MartinPdeS/PyFiberModes/releases/tag/v0.13.2
 [0.13.1]: https://github.com/MartinPdeS/PyFiberModes/releases/tag/v0.13.1
 [0.13.0]: https://github.com/MartinPdeS/PyFiberModes/releases/tag/v0.13.0
 [0.12.0]: https://github.com/MartinPdeS/PyFiberModes/releases/tag/v0.12.0

{pyfibermodes-0.13.1 → pyfibermodes-0.14.0}/CITATION.cff

@@ -14,6 +14,9 @@ url: "https://martinpdes.github.io/PyFiberModes/"
 keywords:
   - optical fibers
   - guided modes
+  - mode solver
+  - optical waveguides
+  - photonics
   - effective index
   - dispersion
   - coupled-mode theory

{pyfibermodes-0.13.1 → pyfibermodes-0.14.0}/CONTRIBUTING.md

@@ -1,6 +1,6 @@
 # Contributing to PyFiberModes
 
-Use Python 3.10 or newer. Install development dependencies with `python -m pip install -e ".[testing,documentation]"`, then run `python -m pytest`.
+Use Python 3.11 or newer. Install development dependencies with `python -m pip install -e ".[testing,documentation]"`, then run `python -m pytest`.
 
 Releases use semantic version tags. Run `make patch`, `make minor`, or `make major` from a clean `master` checkout; the command creates the release commit, tags it, and pushes both. Publishing workflows run only for `v*` tags.
 

{pyfibermodes-0.13.1 → pyfibermodes-0.14.0}/Makefile

@@ -31,6 +31,7 @@ test:
 
 quality:
 	$(PYTHON) -m ruff check PyFiberModes tests tools
+	$(PYTHON) -m mypy
 
 release-check:
 	$(PYTHON) tools/check_release.py $(if $(VERSION),--version $(VERSION),)

{pyfibermodes-0.13.1 → pyfibermodes-0.14.0}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.4
 Name: PyFiberModes
-Version: 0.13.1
-Summary: A package for light propagation in fiber optics.
+Version: 0.14.0
+Summary: Guided-mode analysis and design for circular optical fibers.
 Author-email: Martin Poinsinet de Sivry-Houle <martin.poinsinet.de.sivry@gmail.com>
 License:                     GNU GENERAL PUBLIC LICENSE
                                Version 3, 29 June 2007
@@ -682,9 +682,10 @@ Project-URL: Homepage, https://github.com/MartinPdeS/PyFiberModes
 Project-URL: Repository, https://github.com/MartinPdeS/PyFiberModes
 Project-URL: Issues, https://github.com/MartinPdeS/PyFiberModes/issues
 Project-URL: Documentation, https://martinpdes.github.io/PyFiberModes/
-Keywords: finit-difference,matrix
+Keywords: fiber optics,guided modes,mode solver,optical waveguides,photonics,dispersion,coupled-mode theory
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
@@ -693,12 +694,10 @@ 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
+Requires-Python: >=3.11
 Description-Content-Type: text/x-rst
 License-File: LICENSE
-Requires-Dist: PyOptik<3,>=2
 Requires-Dist: PyFinitDiff
-Requires-Dist: matplotlib>=3.8
 Requires-Dist: pyyaml
 Requires-Dist: numpy
 Requires-Dist: scipy
@@ -708,10 +707,14 @@ Requires-Dist: pytest-cov<8,>=2; extra == "testing"
 Requires-Dist: pytest-json-report~=1.5; extra == "testing"
 Requires-Dist: coverage~=7.6; extra == "testing"
 Requires-Dist: ruff<1,>=0.8; extra == "testing"
-Requires-Dist: tomli<3,>=2; python_version < "3.11" and extra == "testing"
+Requires-Dist: matplotlib>=3.8; extra == "testing"
+Requires-Dist: mypy<2,>=1.15; extra == "testing"
+Provides-Extra: plotting
+Requires-Dist: matplotlib>=3.8; extra == "plotting"
 Provides-Extra: benchmarking
 Requires-Dist: pytest-benchmark<6,>=5; extra == "benchmarking"
 Provides-Extra: documentation
+Requires-Dist: matplotlib>=3.8; extra == "documentation"
 Requires-Dist: numpydoc==1.10.0; extra == "documentation"
 Requires-Dist: sphinx>=5.1.1; extra == "documentation"
 Requires-Dist: sphinx-gallery==0.21.0; extra == "documentation"
@@ -720,6 +723,7 @@ Requires-Dist: sphinx-rtd-theme==3.1.0; extra == "documentation"
 Requires-Dist: pydata-sphinx-theme==0.17.1; extra == "documentation"
 Provides-Extra: dev
 Requires-Dist: ruff<1,>=0.8; extra == "dev"
+Requires-Dist: mypy<2,>=1.15; extra == "dev"
 Dynamic: license-file
 
 .. image:: https://raw.githubusercontent.com/MartinPdeS/PyFiberModes/master/docs/source/_static/logo.png
@@ -784,13 +788,19 @@ Features
 Installation
 ------------
 
-PyFiberModes requires Python 3.10 or newer. Install the released package from
+PyFiberModes requires Python 3.11 or newer. Install the released package from
 PyPI:
 
 .. code-block:: bash
 
    python -m pip install PyFiberModes
 
+Matplotlib-based field visualizations are optional:
+
+.. code-block:: bash
+
+   python -m pip install "PyFiberModes[plotting]"
+
 or from Anaconda:
 
 .. code-block:: bash
@@ -804,9 +814,9 @@ simulations:
 
    python -c "import PyFiberModes; print(PyFiberModes.__version__)"
 
-PyFiberModes currently uses the ``MaterialBank`` interface provided by
-PyOptik 2.x. Released dependency metadata selects the compatible
-``PyOptik>=2,<3`` range automatically.
+Fiber material names are resolved through a lightweight, pluggable registry.
+PyOptik is not required; applications can register their own dispersive model
+objects or simple wavelength-to-index callables.
 
 First mode calculation
 ----------------------
@@ -1003,6 +1013,17 @@ contains the API reference and executable example gallery, including:
 * double-clad fiber field analysis; and
 * comparisons between supported analytical solvers.
 
+API stability
+-------------
+
+Supported imports come from the package root, for example
+``from PyFiberModes import Fiber, LP01``. The
+`public API policy <https://martinpdes.github.io/PyFiberModes/latest/api_policy.html>`_
+defines compatibility guarantees and the deprecation period. Review the
+`migration guide <https://martinpdes.github.io/PyFiberModes/latest/migration_guide.html>`_
+when upgrading across minor or major versions. Internal solver modules are not
+covered by the compatibility guarantee.
+
 Development and testing
 -----------------------
 
@@ -1028,7 +1049,7 @@ Or run the complete local check target:
 
    make check
 
-Tests run on Python 3.10 through 3.13 in GitHub Actions. Bug reports and
+Tests run on Python 3.11 through 3.13 in GitHub Actions. Bug reports and
 feature proposals are welcome through the
 `issue tracker <https://github.com/MartinPdeS/PyFiberModes/issues>`_.
 

{pyfibermodes-0.13.1 → pyfibermodes-0.14.0}/PyFiberModes/__init__.py

@@ -1,7 +1,27 @@
 """Public API for circular optical-fiber mode analysis."""
 
-from PyFiberModes.mode import Mode, Family  # noqa: F401
-from PyFiberModes.mode_instances import *  # noqa: F403
+from PyFiberModes.mode import Family, Mode
+from PyFiberModes.mode_instances import (
+    EH11,
+    HE11,
+    HE12,
+    HE21,
+    HE22,
+    HE31,
+    HE32,
+    LP01,
+    LP02,
+    LP03,
+    LP11,
+    LP12,
+    LP21,
+    LP22,
+    LP31,
+    LP32,
+    LP41,
+    TE01,
+    TM01,
+)
 from PyFiberModes.factory import FiberFactory
 from PyFiberModes.fiber import Fiber, load_fiber
 from PyFiberModes.field import Field
@@ -12,6 +32,13 @@ from PyFiberModes.solver.results import SolverResult
 from PyFiberModes.analysis import ModeSweepResult, find_modes, sweep_modes
 from PyFiberModes.optimization import DesignParameter, DesignResult, optimize_fiber
 from PyFiberModes.propagation import CoupledModeSystem, PropagationResult, coupling_matrix, overlap
+from PyFiberModes.materials import (
+    CallableIndex,
+    ConstantIndex,
+    FusedSilica,
+    MaterialRegistry,
+    RefractiveIndexModel,
+)
 
 
 try:
@@ -21,7 +48,7 @@ except ImportError:
     __version__ = "0.0.0"
 
 
-__all__ = [  # noqa: F405
+__all__ = [
     'Mode',
     'Family',
     'Fiber',
@@ -34,10 +61,17 @@ __all__ = [  # noqa: F405
     'ModeSweepResult', 'find_modes', 'sweep_modes',
     'DesignParameter', 'DesignResult', 'optimize_fiber',
     'CoupledModeSystem', 'PropagationResult', 'coupling_matrix', 'overlap',
+    'RefractiveIndexModel', 'ConstantIndex', 'CallableIndex', 'FusedSilica',
+    'MaterialRegistry',
     'HE11',
     'HE12',
+    'HE21',
     'HE22',
     'HE31',
+    'HE32',
+    'EH11',
+    'TE01',
+    'TM01',
     'LP01',
     'LP11',
     'LP21',
@@ -47,4 +81,5 @@ __all__ = [  # noqa: F405
     'LP22',
     'LP03',
     'LP32',
+    'LP41',
 ]

{pyfibermodes-0.13.1 → pyfibermodes-0.14.0}/PyFiberModes/_version.py

@@ -18,7 +18,7 @@ version_tuple: tuple[int | str, ...]
 commit_id: str | None
 __commit_id__: str | None
 
-__version__ = version = '0.13.1'
-__version_tuple__ = version_tuple = (0, 13, 1)
+__version__ = version = '0.14.0'
+__version_tuple__ = version_tuple = (0, 14, 0)
 
 __commit_id__ = commit_id = None

{pyfibermodes-0.13.1 → pyfibermodes-0.14.0}/PyFiberModes/analysis.py

@@ -64,7 +64,7 @@ class ModeSweepResult:
         index = self.modes.index(mode)
         return {name: value[:, index] for name, value in self.values.items()}
 
-    def as_records(self) -> list[dict]:
+    def as_records(self) -> list[dict[str, float | Mode]]:
         """Convert the dense result into row-oriented records.
 
         Returns
@@ -133,9 +133,13 @@ def find_modes(fiber, families=("LP",), max_nu=6, max_m=6) -> tuple[Mode, ...]:
     found = []
     for mode in candidate_modes(families, max_nu, max_m):
         try:
-            neff = fiber.get_effective_index(mode)
-            guided = fiber.last_layer.refractive_index < neff <= fiber.maximum_index
-            if np.isfinite(neff) and guided:
+            effective_index = fiber.get_effective_index(mode)
+            guided = (
+                fiber.last_layer.refractive_index
+                < effective_index
+                <= fiber.maximum_index
+            )
+            if np.isfinite(effective_index) and guided:
                 found.append(mode)
         except (ArithmeticError, AssertionError, RuntimeError, ValueError):
             continue
@@ -191,7 +195,6 @@ def sweep_modes(
     parameters = np.asarray(tuple(parameters), dtype=float)
     if parameters.ndim != 1 or not len(parameters):
         raise ValueError("parameters must be a non-empty one-dimensional sequence")
-    working_fiber = deepcopy(fiber)
     if setter is None:
         if parameter_name != "wavelength":
             raise ValueError("a setter is required for non-wavelength sweeps")
@@ -202,19 +205,26 @@ def sweep_modes(
     if modes is None:
         discovered = []
         for parameter in parameters:
-            setter(working_fiber, float(parameter))
-            for mode in find_modes(working_fiber, families, max_nu, max_m):
+            parameter_fiber = deepcopy(fiber)
+            setter(parameter_fiber, float(parameter))
+            for mode in find_modes(parameter_fiber, families, max_nu, max_m):
                 if mode not in discovered:
                     discovered.append(mode)
         modes = discovered
     modes = tuple(modes)
     values = {metric: np.full((len(parameters), len(modes)), np.nan) for metric in metrics}
-    for i, parameter in enumerate(parameters):
-        setter(working_fiber, float(parameter))
-        for j, mode in enumerate(modes):
-            for metric in metrics:
+    parameter_fibers = tuple(deepcopy(fiber) for _ in parameters)
+    for parameter_fiber, parameter in zip(parameter_fibers, parameters, strict=True):
+        setter(parameter_fiber, float(parameter))
+
+    for i, parameter_fiber in enumerate(parameter_fibers):
+        metric_functions = {
+            metric: getattr(parameter_fiber, f"get_{metric}") for metric in metrics
+        }
+        for metric, metric_function in metric_functions.items():
+            for j, mode in enumerate(modes):
                 try:
-                    value = getattr(working_fiber, f"get_{metric}")(mode)
+                    value = metric_function(mode)
                     values[metric][i, j] = value if np.isfinite(value) else np.nan
                 except (ArithmeticError, AssertionError, RuntimeError, ValueError):
                     pass

{pyfibermodes-0.13.1 → pyfibermodes-0.14.0}/PyFiberModes/factory.py

@@ -55,10 +55,6 @@ class FiberFactory:
     ----------
     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.
     """
@@ -72,8 +68,6 @@ class FiberFactory:
             Vacuum wavelength in meters for generated fibers.
         """
         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):

{pyfibermodes-0.13.1 → pyfibermodes-0.14.0}/PyFiberModes/fiber.py

@@ -22,6 +22,7 @@ from PyFiberModes.fundamentals import (
 from PyFiberModes import loader
 from PyFiberModes.coordinates import CylindricalCoordinates
 from PyFiberModes.exceptions import ValidationError
+from PyFiberModes.materials import DEFAULT_MATERIALS, MaterialRegistry
 from PyFiberModes.services import FieldAnalysis, ModalAnalysis
 
 
@@ -1004,7 +1005,12 @@ def get_fiber_from_delta_and_V0(delta: float, V0: float, wavelength: float) -> F
     return fiber
 
 
-def load_fiber(fiber_name: str, wavelength: float = None, add_air_layer: bool = False) -> Fiber:
+def load_fiber(
+    fiber_name: str,
+    wavelength: float | None = None,
+    add_air_layer: bool = False,
+    materials: MaterialRegistry = DEFAULT_MATERIALS,
+) -> Fiber:
     """Load a named YAML fiber definition.
 
     Parameters
@@ -1015,6 +1021,8 @@ def load_fiber(fiber_name: str, wavelength: float = None, add_air_layer: bool =
         Vacuum wavelength in meters used to evaluate material indices.
     add_air_layer : bool, optional
         Add an outer air layer when true.
+    materials : MaterialRegistry, optional
+        Registry used to resolve material names in the YAML definition.
 
     Returns
     -------
@@ -1024,7 +1032,8 @@ def load_fiber(fiber_name: str, wavelength: float = None, add_air_layer: bool =
     fiber_dict = loader.load_fiber_as_dict(
         fiber_name=fiber_name,
         wavelength=wavelength,
-        order='out-to-in'
+        order='out-to-in',
+        materials=materials,
     )
 
     fiber = Fiber(wavelength=wavelength)

{pyfibermodes-0.13.1 → pyfibermodes-0.14.0}/PyFiberModes/field.py

@@ -1,24 +1,16 @@
 """Vectorized electric and magnetic field evaluation on Cartesian grids."""
 
 import numpy
-from typing import Callable
+from typing import Any, Callable
 import scipy
 import numpy as np
 from PyFiberModes.mode_instances import HE11
 from PyFiberModes.mode import Mode
 from dataclasses import dataclass
-import matplotlib.pyplot as plt
-from matplotlib.colors import LinearSegmentedColormap
 from PyFiberModes.coordinates import CartesianCoordinates
 from PyFiberModes.coordinates import CylindricalCoordinates as CylindricalCoordinates  # noqa: F401
 
 
-BLUE_BLACK_RED = LinearSegmentedColormap.from_list(
-    "blue_black_red",
-    ("#2455a4", "#000000", "#d73027"),
-)
-
-
 @dataclass
 class Field:
     """
@@ -1167,10 +1159,12 @@ class Field:
         return overlap(self, other)
 
     def plot(
-        self, plot_type: list = (), show: bool = True, save_filename: str = None
-    ) -> plt.Figure:
-        """
-        Plotting function.
+        self,
+        plot_type: list[str] | tuple[str, ...] = (),
+        show: bool = True,
+        save_filename: str | None = None,
+    ) -> Any:
+        """Plot selected field components using the optional plotting layer.
 
         Parameters
         ----------
@@ -1184,32 +1178,22 @@ class Field:
 
         Returns
         -------
-        plt.Figure
+        matplotlib.figure.Figure
             The matplotlib Figure object created or used for the plot.
-        """
-        with plt.style.context("default"):
-            figure, axes = plt.subplots(1, len(plot_type))
-
-        axes = np.atleast_1d(axes)
-        fields = self.get_components(components=plot_type)
-        for ax, field_string in zip(axes, plot_type):
-            ax.set_aspect("equal")
-            field = fields[field_string]
-            field = numpy.real_if_close(field)
-            if numpy.iscomplexobj(field):
-                field = numpy.abs(field)
-            max_abs = abs(max(field.max(), field.min()))
-            ax.pcolormesh(field, vmin=-max_abs, vmax=max_abs, cmap=BLUE_BLACK_RED)
 
-        figure.tight_layout()
-
-        if save_filename:
-            figure.savefig(save_filename)
-
-        if show:
-            plt.show()
+        Raises
+        ------
+        ImportError
+            If the optional plotting dependencies are not installed.
+        """
+        from PyFiberModes.plotting import plot_field
 
-        return figure
+        return plot_field(
+            self,
+            plot_type=plot_type,
+            show=show,
+            save_filename=save_filename,
+        )
 
 
 # -