PyFiberModes 0.13.0__tar.gz → 0.13.2__tar.gz

{pyfibermodes-0.13.0 → pyfibermodes-0.13.2}/.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.0 → pyfibermodes-0.13.2}/.gitignore

@@ -8,6 +8,8 @@
 !development
 !docs
 !tests
+!benchmarks/
+!benchmarks/**
 !.flake8
 !.gitignore
 !.pre-commit-config.yaml

{pyfibermodes-0.13.0 → pyfibermodes-0.13.2}/.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.0",
-  "publication_date": "2026-09-22",
+  "version": "0.13.2",
+  "publication_date": "2026-09-23",
   "keywords": [
     "optical fibers",
     "guided modes",
+    "mode solver",
+    "optical waveguides",
+    "photonics",
     "effective index",
     "dispersion",
     "coupled-mode theory"

{pyfibermodes-0.13.0 → pyfibermodes-0.13.2}/CHANGELOG.md

@@ -6,6 +6,37 @@ use [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
 
+## [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
+
+- Added validated immutable layer and solver settings, structural solver
+  protocols, domain-specific exceptions, and structured solver diagnostics.
+- Added deterministic physical-reference, convergence, caching, architecture,
+  and opt-in `pytest-benchmark` performance suites.
+
+### Changed
+
+- Unified cylindrical coordinates under one canonical model, split modal and
+  field orchestration into focused services, and added geometry-aware caching.
+- Vectorized radial index lookup and routed field construction through a
+  single batched radial-field interface.
+- Standardized the group-velocity API on `get_group_velocity` and removed
+  unreferenced experimental modules, unfinished solver branches, misspelled
+  methods, lowercase directory aliases, and obsolete compatibility wrappers.
+
 ## [0.13.0] - 2026-09-22
 
 ### Changed
@@ -55,7 +86,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.0...HEAD
+[Unreleased]: https://github.com/MartinPdeS/PyFiberModes/compare/v0.13.2...HEAD
+[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
 [0.11.0]: https://github.com/MartinPdeS/PyFiberModes/releases/tag/v0.11.0

{pyfibermodes-0.13.0 → pyfibermodes-0.13.2}/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.0 → pyfibermodes-0.13.2}/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.0 → pyfibermodes-0.13.2}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.4
 Name: PyFiberModes
-Version: 0.13.0
-Summary: A package for light propagation in fiber optics.
+Version: 0.13.2
+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,11 @@ 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,8 +708,13 @@ 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"
+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"
@@ -775,17 +780,26 @@ Features
 * Constrained optimization of layer radii, refractive indices, and custom parameters.
 * Constant or longitudinally varying coupled-mode propagation.
 * A catalog of common and example fiber definitions stored as readable YAML files.
+* Structured solver diagnostics, validated configuration models, and explicit
+  solver protocols for extending numerical backends.
+* Geometry-aware modal caching and vectorized radial index and field workflows.
 
 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
@@ -1023,7 +1037,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.0 → pyfibermodes-0.13.2}/PyFiberModes/__init__.py

@@ -3,7 +3,12 @@
 from PyFiberModes.mode import Mode, Family  # noqa: F401
 from PyFiberModes.mode_instances import *  # noqa: F403
 from PyFiberModes.factory import FiberFactory
+from PyFiberModes.fiber import Fiber, load_fiber
 from PyFiberModes.field import Field
+from PyFiberModes.coordinates import CartesianCoordinates, CylindricalCoordinates
+from PyFiberModes.exceptions import ConvergenceError, SolverError, ValidationError
+from PyFiberModes.models import LayerSpec, SolverSettings
+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
@@ -17,11 +22,15 @@ except ImportError:
 
 
 __all__ = [  # noqa: F405
-    'Wavelength',
     'Mode',
-    'ModeFamily',
+    'Family',
+    'Fiber',
+    'load_fiber',
     'FiberFactory',
     'Field',
+    'CartesianCoordinates', 'CylindricalCoordinates',
+    'LayerSpec', 'SolverSettings', 'SolverResult',
+    'ValidationError', 'SolverError', 'ConvergenceError',
     'ModeSweepResult', 'find_modes', 'sweep_modes',
     'DesignParameter', 'DesignResult', 'optimize_fiber',
     'CoupledModeSystem', 'PropagationResult', 'coupling_matrix', 'overlap',

{pyfibermodes-0.13.0 → pyfibermodes-0.13.2}/PyFiberModes/_version.py

@@ -18,7 +18,7 @@ version_tuple: tuple[int | str, ...]
 commit_id: str | None
 __commit_id__: str | None
 
-__version__ = version = '0.13.0'
-__version_tuple__ = version_tuple = (0, 13, 0)
+__version__ = version = '0.13.2'
+__version_tuple__ = version_tuple = (0, 13, 2)
 
 __commit_id__ = commit_id = None

{pyfibermodes-0.13.0 → pyfibermodes-0.13.2}/PyFiberModes/coordinates.py

@@ -74,9 +74,9 @@ class CartesianCoordinates:
 
     def __post_init__(self) -> None:
         """Convert all coordinate arrays to floating-point arrays."""
-        self.x = self.x.astype(float)
-        self.y = self.y.astype(float)
-        self.z = self.z.astype(float)
+        self.x = np.asarray(self.x, dtype=float)
+        self.y = np.asarray(self.y, dtype=float)
+        self.z = np.asarray(self.z, dtype=float)
 
     @property
     def x_boundaries(self) -> Tuple[float, float]:
@@ -119,7 +119,8 @@ class CartesianCoordinates:
         """
         if self.is_structured:
             x_min, x_max = self.x_boundaries
-            return (x_max - x_min) / len(self.x)
+            unique_x = np.unique(self.x)
+            return float(unique_x[1] - unique_x[0])
         raise ValueError("dx value cannot be inferred from an unstructured mesh.")
 
     @property
@@ -139,7 +140,8 @@ class CartesianCoordinates:
         """
         if self.is_structured:
             y_min, y_max = self.y_boundaries
-            return (y_max - y_min) / len(self.y)
+            unique_y = np.unique(self.y)
+            return float(unique_y[1] - unique_y[0])
         raise ValueError("dx value cannot be inferred from an unstructured mesh.")
 
     @classmethod

{pyfibermodes-0.13.0 → pyfibermodes-0.13.2}/PyFiberModes/directories.py

@@ -9,11 +9,6 @@ __all__ = [
     "DOCS_PATH",
     "EXAMPLES_PATH",
     "DOC_CSS_PATH",
-    "root_path",
-    "project_path",
-    "examples_path",
-    "doc_path",
-    "doc_css_path",
 ]
 
 PACKAGE_PATH = Path(__file__).resolve().parent
@@ -21,10 +16,3 @@ PROJECT_PATH = PACKAGE_PATH.parent
 DOCS_PATH = PROJECT_PATH / "docs"
 EXAMPLES_PATH = DOCS_PATH / "examples"
 DOC_CSS_PATH = DOCS_PATH / "source" / "_static" / "default.css"
-
-# Backwards-compatible aliases for the original public names.
-root_path = PACKAGE_PATH
-project_path = PROJECT_PATH
-doc_path = DOCS_PATH
-examples_path = EXAMPLES_PATH
-doc_css_path = DOC_CSS_PATH

pyfibermodes-0.13.2/PyFiberModes/exceptions.py

@@ -0,0 +1,17 @@
+"""Domain-specific exceptions raised by PyFiberModes."""
+
+
+class PyFiberModesError(Exception):
+    """Base class for package-specific errors."""
+
+
+class ValidationError(PyFiberModesError, ValueError):
+    """Indicate invalid physical geometry or solver configuration."""
+
+
+class SolverError(PyFiberModesError, RuntimeError):
+    """Indicate that a modal solver could not complete normally."""
+
+
+class ConvergenceError(SolverError):
+    """Indicate that a numerical solver did not converge to a valid root."""