PyFiberModes 0.11.0__tar.gz → 0.12.0__tar.gz

{pyfibermodes-0.11.0 → pyfibermodes-0.12.0}/.zenodo.json

@@ -9,7 +9,7 @@
   "license": "MIT",
   "upload_type": "software",
   "access_right": "open",
-  "version": "0.11.0",
+  "version": "0.12.0",
   "publication_date": "2026-09-22",
   "keywords": [
     "optical fibers",

{pyfibermodes-0.11.0 → pyfibermodes-0.12.0}/CHANGELOG.md

@@ -6,6 +6,14 @@ use [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
 
+## [0.12.0] - 2026-09-22
+
+### Changed
+
+- Consolidated filesystem locations in the root `directories` module and removed
+  the duplicate internal `tools` package.
+- Moved solver-test helpers out of the distributed package and into the test suite.
+
 ## [0.11.0] - 2026-09-22
 
 ### Added
@@ -33,6 +41,7 @@ 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.11.0...HEAD
+[Unreleased]: https://github.com/MartinPdeS/PyFiberModes/compare/v0.12.0...HEAD
+[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
 [0.10.0]: https://github.com/MartinPdeS/PyFiberModes/releases/tag/v0.10.0

{pyfibermodes-0.11.0 → pyfibermodes-0.12.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PyFiberModes
-Version: 0.11.0
+Version: 0.12.0
 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

{pyfibermodes-0.11.0 → pyfibermodes-0.12.0}/PyFiberModes/_version.py

@@ -18,7 +18,7 @@ version_tuple: tuple[int | str, ...]
 commit_id: str | None
 __commit_id__: str | None
 
-__version__ = version = '0.11.0'
-__version_tuple__ = version_tuple = (0, 11, 0)
+__version__ = version = '0.12.0'
+__version_tuple__ = version_tuple = (0, 12, 0)
 
 __commit_id__ = commit_id = None

pyfibermodes-0.12.0/PyFiberModes/directories.py

@@ -0,0 +1,30 @@
+"""Canonical filesystem locations used by PyFiberModes and its documentation."""
+
+from pathlib import Path
+
+
+__all__ = [
+    "PACKAGE_PATH",
+    "PROJECT_PATH",
+    "DOCS_PATH",
+    "EXAMPLES_PATH",
+    "DOC_CSS_PATH",
+    "root_path",
+    "project_path",
+    "examples_path",
+    "doc_path",
+    "doc_css_path",
+]
+
+PACKAGE_PATH = Path(__file__).resolve().parent
+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.11.0 → pyfibermodes-0.12.0}/PyFiberModes.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PyFiberModes
-Version: 0.11.0
+Version: 0.12.0
 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

{pyfibermodes-0.11.0 → pyfibermodes-0.12.0}/PyFiberModes.egg-info/SOURCES.txt

@@ -67,9 +67,6 @@ PyFiberModes/solver/ssif/cutoff.py
 PyFiberModes/solver/ssif/neff.py
 PyFiberModes/solver/tlsif/__init__.py
 PyFiberModes/solver/tlsif/cutoff.py
-PyFiberModes/tools/__init__.py
-PyFiberModes/tools/directories.py
-PyFiberModes/tools/utils.py
 conda.recipe/meta.yaml
 docs/Makefile
 docs/make.bat
@@ -98,8 +95,10 @@ docs/source/index.rst
 docs/source/_static/default.css
 docs/source/_static/thumbnail.png
 tests/__init__.py
+tests/helpers.py
 tests/test_advanced_features.py
 tests/test_api.py
+tests/test_architecture.py
 tests/test_coordinates.py
 tests/test_fiber.py
 tests/test_field.py

{pyfibermodes-0.11.0 → pyfibermodes-0.12.0}/conda.recipe/meta.yaml

@@ -1,6 +1,6 @@
 package:
   name: pyfibermodes
-  version: 0.11.0
+  version: 0.12.0
 
 source:
   path: ../

{pyfibermodes-0.11.0 → pyfibermodes-0.12.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "PyFiberModes"
-version = "0.11.0"
+version = "0.12.0"
 description = "A package for light propagation in fiber optics."
 license = {file = "LICENSE"}
 readme = "README.rst"

pyfibermodes-0.12.0/tests/__init__.py

@@ -0,0 +1 @@
+"""PyFiberModes test suite."""

pyfibermodes-0.12.0/tests/helpers.py

@@ -0,0 +1,13 @@
+"""Shared test helpers that are intentionally not part of the public package."""
+
+import numpy
+
+
+def get_mode_beta(fiber, mode_list: list, itr_list: list) -> dict[str, numpy.ndarray]:
+    """Evaluate effective indices while scaling a fiber through ``itr_list``."""
+    return {
+        repr(mode): numpy.asarray(
+            [fiber.scale(factor=itr).get_effective_index(mode=mode) for itr in itr_list]
+        )
+        for mode in mode_list
+    }

pyfibermodes-0.12.0/tests/test_architecture.py

@@ -0,0 +1,27 @@
+from pathlib import Path
+
+import PyFiberModes
+from PyFiberModes import directories
+
+
+def test_directory_locations_are_derived_from_module_location():
+    package_path = Path(PyFiberModes.__file__).resolve().parent
+
+    assert directories.PACKAGE_PATH == package_path
+    assert directories.PROJECT_PATH == package_path.parent
+    assert directories.DOCS_PATH == package_path.parent / "docs"
+    assert directories.EXAMPLES_PATH == directories.DOCS_PATH / "examples"
+    assert directories.DOC_CSS_PATH.is_file()
+
+
+def test_legacy_directory_names_are_aliases():
+    assert directories.root_path is directories.PACKAGE_PATH
+    assert directories.project_path is directories.PROJECT_PATH
+    assert directories.doc_path is directories.DOCS_PATH
+    assert directories.examples_path is directories.EXAMPLES_PATH
+    assert directories.doc_css_path is directories.DOC_CSS_PATH
+
+
+def test_package_has_no_generic_tools_namespace():
+    tools_path = directories.PACKAGE_PATH / "tools"
+    assert not tools_path.exists() or not any(tools_path.glob("*.py"))

{pyfibermodes-0.11.0 → pyfibermodes-0.12.0}/tests/test_ssif.py

@@ -4,8 +4,8 @@
 import numpy
 import pytest
 from PyFiberModes.fiber import load_fiber
-from PyFiberModes.tools.utils import get_mode_beta
 from PyFiberModes import HE11, TE01, TM01, EH11, LP01
+from tests.helpers import get_mode_beta
 
 
 def test_solver():

{pyfibermodes-0.11.0 → pyfibermodes-0.12.0}/tests/test_tlsif.py

@@ -4,8 +4,8 @@
 import numpy
 import pytest
 from PyFiberModes.fiber import load_fiber
-from PyFiberModes.tools.utils import get_mode_beta
 from PyFiberModes import HE11, TE01, TM01, EH11, LP01
+from tests.helpers import get_mode_beta
 
 
 def test_solver():

{pyfibermodes-0.11.0 → pyfibermodes-0.12.0}/tests/test_validation.py

@@ -5,8 +5,8 @@ import numpy
 import pytest
 from PyFiberModes.fiber import get_fiber_from_delta_and_V0
 from PyFiberModes.fiber import load_fiber
-from PyFiberModes.tools.utils import get_mode_beta
 from PyFiberModes import HE11, TE01, TM01, HE21, EH11, HE31, HE12, LP01
+from tests.helpers import get_mode_beta
 
 
 def test_validation_cutoff_wavelength():

pyfibermodes-0.11.0/PyFiberModes/directories.py

@@ -1,32 +0,0 @@
-#!/usr/bin/env python
-# -*- coding: utf-8 -*-
-
-from pathlib import Path
-import PyFiberModes
-
-
-__all__ = [
-    'root_path',
-    'project_path',
-    'examples_path',
-    'doc_path',
-    'doc_css_path',
-]
-
-root_path = Path(PyFiberModes.__path__[0])
-
-project_path = root_path.parents[0]
-
-doc_path = project_path.joinpath('docs')
-
-examples_path = doc_path.joinpath('examples')
-
-logo_path = doc_path.joinpath('images/logo.png')
-
-doc_css_path = doc_path.joinpath('source/_static/default.css')
-
-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.11.0/PyFiberModes/tools/directories.py

@@ -1,41 +0,0 @@
-#!/usr/bin/env python
-# -*- coding: utf-8 -*-
-
-from pathlib import Path
-import PyFiberModes
-
-
-__all__ = [
-    'root_path',
-    'project_path',
-    'examples_path',
-    'version_path',
-    'doc_path',
-    # 'logo_path',
-    'doc_css_path',
-]
-
-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')
-
-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.11.0/PyFiberModes/tools/utils.py

@@ -1,20 +0,0 @@
-#!/usr/bin/env python
-# -*- coding: utf-8 -*-
-
-import numpy
-
-
-def get_mode_beta(fiber, mode_list: list, itr_list: list):
-    data_dict = {}
-    for mode in mode_list:
-        data_list = []
-        for j, itr in enumerate(itr_list):
-            _fiber = fiber.scale(factor=itr)
-            neff = _fiber.get_effective_index(mode=mode)
-            data_list.append(neff)
-
-        data_dict[mode.__repr__()] = numpy.asarray(data_list)
-
-    return data_dict
-
-# -