PyFiberModes 0.10.0__tar.gz → 0.12.0__tar.gz

pyfibermodes-0.12.0/.github/workflows/deploy_PyPi.yml

@@ -0,0 +1,29 @@
+name: Publish to PyPI
+
+on:
+  push:
+    tags: ["v*"]
+
+permissions:
+  contents: read
+
+jobs:
+  validate-release:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@fbc6f3992d24b796d5a048ff273f7fcc4a7b6c09
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1
+        with:
+          python-version: "3.11"
+      - run: python tools/check_release.py --version "${GITHUB_REF_NAME}"
+
+  publish:
+    needs: validate-release
+    uses: MartinPdeS/MPSActions/.github/workflows/publish_pure_package_to_PyPi.yml@v5
+    with:
+      python-version: "3.11"
+      test-command: python -c 'import PyFiberModes'
+    secrets:
+      PYPI_API_TOKEN: ${{ secrets.PYPI_API_TOKEN }}

pyfibermodes-0.12.0/.github/workflows/deploy_anaconda.yml

@@ -0,0 +1,32 @@
+name: Publish Conda package
+
+on:
+  push:
+    tags: ["v*"]
+
+permissions:
+  contents: read
+
+jobs:
+  validate-release:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@fbc6f3992d24b796d5a048ff273f7fcc4a7b6c09
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1
+        with:
+          python-version: "3.11"
+      - run: python tools/check_release.py --version "${GITHUB_REF_NAME}"
+
+  publish:
+    needs: validate-release
+    uses: MartinPdeS/MPSActions/.github/workflows/publish_compiled_package_to_anaconda.yml@v5
+    with:
+      python_versions: '["3.11", "3.12", "3.13"]'
+      os_list: '["ubuntu-latest", "macos-latest", "windows-latest"]'
+      package_name: pyfibermodes
+      recipe_path: conda.recipe
+      test_import: PyFiberModes
+    secrets:
+      ANACONDA_API_TOKEN: ${{ secrets.ANACONDA_API_TOKEN }}

pyfibermodes-0.12.0/.github/workflows/deploy_coverage.yml

@@ -0,0 +1,21 @@
+name: Publish coverage
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  coverage:
+    uses: MartinPdeS/MPSActions/.github/workflows/publish_coverage.yml@v5
+    with:
+      python-version: "3.11"
+      apt-package: xvfb
+      coverage-package: PyFiberModes
+    secrets:
+      _GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

pyfibermodes-0.12.0/.github/workflows/deploy_documentation.yml

@@ -0,0 +1,19 @@
+name: Publish documentation
+
+on:
+  push:
+    branches: [master]
+    tags: ["v*"]
+
+permissions:
+  contents: write
+  pages: write
+  id-token: write
+
+jobs:
+  documentation:
+    uses: MartinPdeS/MPSActions/.github/workflows/publish_documentation.yml@v5
+    with:
+      python-version: "3.11"
+      package-name: PyFiberModes
+      apt-package: xvfb jq

pyfibermodes-0.12.0/.github/workflows/quality.yml

@@ -0,0 +1,22 @@
+name: Static quality checks
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+
+permissions:
+  contents: read
+
+jobs:
+  quality:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@fbc6f3992d24b796d5a048ff273f7fcc4a7b6c09
+      - uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1
+        with:
+          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 tools/check_release.py

pyfibermodes-0.12.0/.github/workflows/tests.yml

@@ -0,0 +1,28 @@
+name: Tests
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+
+permissions:
+  contents: read
+
+jobs:
+  tests:
+    name: Python ${{ matrix.python-version }}
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@fbc6f3992d24b796d5a048ff273f7fcc4a7b6c09
+      - uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1
+        with:
+          python-version: ${{ matrix.python-version }}
+      - run: python -m pip install --upgrade pip && python -m pip install -e ".[testing]"
+      - run: python -m pytest -q
+        env:
+          MPLBACKEND: Agg

{pyfibermodes-0.10.0 → pyfibermodes-0.12.0}/.gitignore

@@ -12,13 +12,22 @@
 !.gitignore
 !.pre-commit-config.yaml
 !LICENSE
-!meta.yaml
+!conda.recipe
+!conda.recipe/meta.yaml
 !pyproject.toml
 !README.rst
+!CONTRIBUTING.md
+!/Makefile
+!tools
+!tools/*.py
 !notebook.ipynb
 !CMakeLists.txt
 !pytest.ini
 !.coveragerc
+!.zenodo.json
+!CITATION.cff
+!CHANGELOG.md
+!MANIFEST.in
 
 # But ignore docs/build inside docs and code
 docs/build/
@@ -29,3 +38,4 @@ docs/source/gallery/
 *.DS_Store*
 *.so*
 *.a*
+!Makefile

pyfibermodes-0.12.0/.zenodo.json

@@ -0,0 +1,21 @@
+{
+  "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.",
+  "creators": [
+    {
+      "name": "Poinsinet de Sivry-Houle, Martin"
+    }
+  ],
+  "license": "MIT",
+  "upload_type": "software",
+  "access_right": "open",
+  "version": "0.12.0",
+  "publication_date": "2026-09-22",
+  "keywords": [
+    "optical fibers",
+    "guided modes",
+    "effective index",
+    "dispersion",
+    "coupled-mode theory"
+  ]
+}

pyfibermodes-0.12.0/CHANGELOG.md

@@ -0,0 +1,47 @@
+# Changelog
+
+All notable changes to PyFiberModes are documented in this file. The format is
+based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and releases
+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
+
+- Automatic guided-mode discovery and structured parameter sweeps.
+- Constrained inverse design for layer radii, refractive indices, and custom parameters.
+- Mode-overlap, coupling-matrix, and coupled-mode propagation utilities.
+- Vectorized field mapping, Poynting vectors, guided power, and confinement factors.
+- Citation metadata for Citation File Format and Zenodo.
+- Release-metadata consistency checks and expanded behavioral unit tests.
+
+### Changed
+
+- Field maps reuse cached radial solutions rather than solving independently at every pixel.
+- Effective-area integration now includes the physical grid-cell area consistently.
+
+### Fixed
+
+- Field intensity and normalization now use the current `Fiber.get_effective_index` API.
+- Radial-field caches are cleared when the fiber wavelength changes.
+
+## [0.10.0] - 2026-02-13
+
+### Changed
+
+- Established the current tagged baseline for subsequent documented releases.
+
+[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.12.0/CITATION.cff

@@ -0,0 +1,19 @@
+cff-version: 1.2.0
+message: "If you use PyFiberModes in your research, please cite this software."
+title: "PyFiberModes"
+type: software
+authors:
+  - family-names: "Poinsinet de Sivry-Houle"
+    given-names: "Martin"
+abstract: >
+  PyFiberModes is a Python package for solving and analysing guided modes in
+  circularly symmetric step-index and multilayer optical fibers.
+license: "MIT"
+repository-code: "https://github.com/MartinPdeS/PyFiberModes"
+url: "https://martinpdes.github.io/PyFiberModes/"
+keywords:
+  - optical fibers
+  - guided modes
+  - effective index
+  - dispersion
+  - coupled-mode theory

pyfibermodes-0.12.0/CONTRIBUTING.md

@@ -0,0 +1,7 @@
+# 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`.
+
+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.
+
+The Conda recipe is at `conda.recipe/meta.yaml`. Do not commit generated documentation, virtual environments, build artefacts, or caches.

pyfibermodes-0.12.0/MANIFEST.in

@@ -0,0 +1,4 @@
+include CITATION.cff
+include CHANGELOG.md
+include .zenodo.json
+include tools/*.py

pyfibermodes-0.12.0/Makefile

@@ -0,0 +1,50 @@
+.DEFAULT_GOAL := help
+
+PYTHON ?= python3
+TAG_VERSION ?= $(or $(VERSION),$(filter v%,$(MAKECMDGOALS)))
+RELEASE_KIND := $(filter major minor patch,$(MAKECMDGOALS))
+
+.PHONY: help test quality check release-check tag release major minor patch
+
+help:
+	@echo "PyFiberModes development commands"
+	@echo ""
+	@echo "  make test                  Run the test suite"
+	@echo "  make quality               Run static quality checks"
+	@echo "  make check                 Run tests, quality, and release checks"
+	@echo "  make release-check         Check version metadata consistency"
+	@echo "  make tag VERSION=vX.Y.Z    Create a release commit and annotated tag"
+	@echo "  make release patch         Create and push the next patch release"
+	@echo "  make release minor         Create and push the next minor release"
+	@echo "  make release major         Create and push the next major release"
+
+ifneq ($(filter tag,$(MAKECMDGOALS)),)
+ifneq ($(strip $(TAG_VERSION)),)
+.PHONY: $(TAG_VERSION)
+$(TAG_VERSION):
+	@:
+endif
+endif
+
+test:
+	MPLBACKEND=Agg $(PYTHON) -m pytest
+
+quality:
+	$(PYTHON) -m ruff check PyFiberModes tests tools
+
+release-check:
+	$(PYTHON) tools/check_release.py $(if $(VERSION),--version $(VERSION),)
+
+check: quality test release-check
+
+tag:
+	$(PYTHON) tools/release_tag.py "$(TAG_VERSION)"
+
+release:
+	@test "$(words $(RELEASE_KIND))" -eq 1 || { echo "usage: make release [patch|minor|major]" >&2; exit 2; }
+	@set -eu; release_tag="$$($(PYTHON) tools/next_release_version.py $(RELEASE_KIND))"; \
+	$(PYTHON) tools/release_tag.py "$$release_tag"; \
+	git push origin HEAD "refs/tags/$$release_tag"
+
+major minor patch:
+	@: