Skip to main content
SuPyMode logo
Propagation of mode in an adiabatic 2x1 modally-specific photonic lantern.

Badge

Status

Python versions

Python

Documentation

Documentation Status

Continuous integration

Unittest Status

Test coverage

Unittest coverage

Google Colab

Google Colab

PyPI package

PyPI version

PyPI downloads

PyPI downloads

Anaconda package

Anaconda version

Anaconda downloads

Anaconda downloads

Latest Anaconda release

Latest release date

SuPyMode

This project aims to develop an useful tool design and optimize fiber optic tapered component. SuPyMode is a Python library linked to a c++ core allowing for a flexible interface and fast computing core. The library also aims to offer the end-user a great vizual tools for data analysis. To this day, SuPyMode as been proven a useful tool to develop very-short 2x1 and 3x1 modally specific photonic lantern with very low loss and cross-talk.

Features

  • Fast and efficient simulation of fiber optic tapered components.

  • User-friendly interface for easy integration into existing workflows.

  • Comprehensive visualization tools for data analysis and interpretation.

Installation

SuPyMode is available on PyPI and Anaconda. Install it with:

pip install SuPyMode
conda install SuPyMode

See the online documentation for detailed usage and additional examples.

Quick example

Below is a short example computing the mode propgation in a simple fiber.

from SuPyMode.workflow import Workflow, fiber_loader, Boundaries, BoundaryValue, DomainAlignment

wavelength = 1550e-9

fiber = fiber_loader.load_fiber('SMF28', clad_refractive_index=1.4444, remove_cladding=False)

boundaries = [
   Boundaries(right=BoundaryValue.SYMMETRIC, top=BoundaryValue.SYMMETRIC),
   Boundaries(right=BoundaryValue.SYMMETRIC, top=BoundaryValue.ANTI_SYMMETRIC)
]


workflow = Workflow(
   fiber_list=[fiber],             # List of fiber to be added in the mesh, the order matters.
   wavelength=wavelength,          # Wavelength used for the mode computation.
   resolution=80,                  # Number of point in the x and y axis [is divided by half if symmetric or anti-symmetric boundaries].
   x_bounds=DomainAlignment.LEFT,  # Mesh x-boundary structure.
   y_bounds=DomainAlignment.BOTTOM,# Mesh y-boundary structure.
   boundaries=boundaries,          # Set of symmetries to be evaluated, each symmetry add a round of simulation
   n_sorted_mode=3,                # Total computed and sorted mode.
   n_added_mode=2,                 # Additional computed mode that are not considered later except for field comparison [the higher the better but the slower].
   plot_geometry=True,             # Plot the geometry mesh before computation.
   auto_label=True,                # Auto labeling the mode. Label are not always correct and should be verified afterwards.
   itr_final=0.05,                 # Final value of inverse taper ratio to simulate
   index_scrambling=0              # Scrambling of refractive index value in order to lift mode degeneracy [useful for some analysis]
)

workflow.superset.plot(plot_type='field', itr_list=[1.0, 0.1])

workflow.superset.plot(plot_type='index')

workflow.superset.plot(plot_type='normalized-coupling')

workflow.superset.plot(plot_type='adiabatic')

Building from source

For development or manual compilation, clone the repository and run:

git submodule update --init
mkdir build && cd build
cmake ../ -G"Unix Makefiles"
sudo make install
cd ..
python -m pip install .

Testing

Run the unit tests with:

pip install SuPyMode[testing]
pytest

Citing SuPyMode

If you use SuPyMode in academic work, please cite:

@article{de2024supymode,
   title={SuPyMode: an open-source library for design and optimization of fiber optic components},
   author={de Sivry-Houle, Martin Poinsinet and Becerra Deana, Rodrigo Itzamna and Virally, St{\'e}phane and Godbout, Nicolas and Boudoux, Caroline},
   journal={Optics Continuum},
   volume={3},
   number={2},
   pages={242--255},
   year={2024},
   publisher={Optica Publishing Group}
}

Contact

For questions or contributions, contact martin.poinsinet.de.sivry@gmail.com.

Metadata

Release files for SuPyMode 2.4.13

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Built distributions (wheels)

Table of built distributions (wheels) for SuPyMode 2.4.13
File Actions
supymode-2.4.13-cp314-cp314-win_amd64.whl CPython 3.14 CPython 3.14 Windows x86-64 Details for supymode-2.4.13-cp314-cp314-win_amd64.whl
supymode-2.4.13-cp314-cp314-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl CPython 3.14 CPython 3.14 Linux glibc 2.28+ x86-64, Linux glibc 2.27+ x86-64 Details for supymode-2.4.13-cp314-cp314-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl
supymode-2.4.13-cp314-cp314-macosx_26_0_arm64.whl CPython 3.14 CPython 3.14 macOS 26.0+ ARM64 Details for supymode-2.4.13-cp314-cp314-macosx_26_0_arm64.whl
supymode-2.4.13-cp313-cp313-win_amd64.whl CPython 3.13 CPython 3.13 Windows x86-64 Details for supymode-2.4.13-cp313-cp313-win_amd64.whl
supymode-2.4.13-cp313-cp313-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl CPython 3.13 CPython 3.13 Linux glibc 2.28+ x86-64, Linux glibc 2.27+ x86-64 Details for supymode-2.4.13-cp313-cp313-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl
supymode-2.4.13-cp313-cp313-macosx_26_0_arm64.whl CPython 3.13 CPython 3.13 macOS 26.0+ ARM64 Details for supymode-2.4.13-cp313-cp313-macosx_26_0_arm64.whl
supymode-2.4.13-cp312-cp312-win_amd64.whl CPython 3.12 CPython 3.12 Windows x86-64 Details for supymode-2.4.13-cp312-cp312-win_amd64.whl
supymode-2.4.13-cp312-cp312-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl CPython 3.12 CPython 3.12 Linux glibc 2.28+ x86-64, Linux glibc 2.27+ x86-64 Details for supymode-2.4.13-cp312-cp312-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl
supymode-2.4.13-cp312-cp312-macosx_26_0_arm64.whl CPython 3.12 CPython 3.12 macOS 26.0+ ARM64 Details for supymode-2.4.13-cp312-cp312-macosx_26_0_arm64.whl
supymode-2.4.13-cp311-cp311-win_amd64.whl CPython 3.11 CPython 3.11 Windows x86-64 Details for supymode-2.4.13-cp311-cp311-win_amd64.whl
supymode-2.4.13-cp311-cp311-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl CPython 3.11 CPython 3.11 Linux glibc 2.28+ x86-64, Linux glibc 2.27+ x86-64 Details for supymode-2.4.13-cp311-cp311-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl
supymode-2.4.13-cp311-cp311-macosx_26_0_arm64.whl CPython 3.11 CPython 3.11 macOS 26.0+ ARM64 Details for supymode-2.4.13-cp311-cp311-macosx_26_0_arm64.whl

Total release size: 24.9 MB

Release files / supymode-2.4.13-cp314-cp314-win_amd64.whl

Download URL supymode-2.4.13-cp314-cp314-win_amd64.whl
Size 3.0 MB
Tags CPython 3.14 Windows x86-64
SHA-256 checksum
How to use checksums
3e3e80501ae2f9ea1f88bf24675846a82b314ed104fea300276eda203dfae284
BLAKE2b-256 checksum
How to use checksums
c1cdad79452136aef5ebe206346b71c1ed30786bfe127544ce090f75629acf99
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.11.17

Release files / supymode-2.4.13-cp314-cp314-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl

Download URL supymode-2.4.13-cp314-cp314-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl
Size 1.1 MB
Tags CPython 3.14 Linux glibc 2.27+ x86-64 Linux glibc 2.28+ x86-64
SHA-256 checksum
How to use checksums
17aefb199b9c4d5d957f33a6d00d77535c9e522bf57886288fd81453cfd0a738
BLAKE2b-256 checksum
How to use checksums
5c62a652490f3f9f4cfd58849b60140eda1a88b3bbc8a573dabee5e46daed93f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.11.17

Release files / supymode-2.4.13-cp314-cp314-macosx_26_0_arm64.whl

Download URL supymode-2.4.13-cp314-cp314-macosx_26_0_arm64.whl
Size 2.3 MB
Tags CPython 3.14 macOS 26.0+ ARM64
SHA-256 checksum
How to use checksums
62e84b84d502ba29e5705b9c54feb2125e9eb6faba24eda9593373419d6e8d72
BLAKE2b-256 checksum
How to use checksums
eeccc45ac1e6785794236ab4ca8806b78adc3af75c48f059188c9a61eb67ac2d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.11.17

Release files / supymode-2.4.13-cp313-cp313-win_amd64.whl

Download URL supymode-2.4.13-cp313-cp313-win_amd64.whl
Size 2.9 MB
Tags CPython 3.13 Windows x86-64
SHA-256 checksum
How to use checksums
b85609cb9fec27199cc16f360ab30682c08c59af2dd02782816132b77694a767
BLAKE2b-256 checksum
How to use checksums
38cd98f5fe60c417f67041fa003100aa44cbe086439ad5136700e477c8ece44f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.11.17

Release files / supymode-2.4.13-cp313-cp313-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl

Download URL supymode-2.4.13-cp313-cp313-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl
Size 1.1 MB
Tags CPython 3.13 Linux glibc 2.27+ x86-64 Linux glibc 2.28+ x86-64
SHA-256 checksum
How to use checksums
46f24ed15a4016ede9dcd7bbef6da4a6280bf14a796ba591b8dac7e3457d20a0
BLAKE2b-256 checksum
How to use checksums
fbc3bda17f0ac5f63c41371be9aeb69a6c6085ac4fd3c7a3700f21931e2026db
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.11.17

Release files / supymode-2.4.13-cp313-cp313-macosx_26_0_arm64.whl

Download URL supymode-2.4.13-cp313-cp313-macosx_26_0_arm64.whl
Size 2.3 MB
Tags CPython 3.13 macOS 26.0+ ARM64
SHA-256 checksum
How to use checksums
b64f3268020b3c27c1b8cd8a41c583ea6cf7fe153f9016d7233b46c12935d355
BLAKE2b-256 checksum
How to use checksums
f3501c1eea805c619d1132f52ac31591cd6ccf481f9014918cd0aebfd4f136ca
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.11.17

Release files / supymode-2.4.13-cp312-cp312-win_amd64.whl

Download URL supymode-2.4.13-cp312-cp312-win_amd64.whl
Size 2.9 MB
Tags CPython 3.12 Windows x86-64
SHA-256 checksum
How to use checksums
f2b03f952a0d3d257941b9c768e9eb5a89dd6be8e4007d47c2c7cb6d98ac01e6
BLAKE2b-256 checksum
How to use checksums
f1233a47d0e7f5455bd5459af62405714510d8c999a13dee491ad81061180bd0
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.11.17

Release files / supymode-2.4.13-cp312-cp312-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl

Download URL supymode-2.4.13-cp312-cp312-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl
Size 1.1 MB
Tags CPython 3.12 Linux glibc 2.27+ x86-64 Linux glibc 2.28+ x86-64
SHA-256 checksum
How to use checksums
b8bb9049886d811fc884d98ca1b0fbc1fa82f96e80ff3ed8a30fe13051b0d1a7
BLAKE2b-256 checksum
How to use checksums
3ec66476da75be66e8b5ce868368344082c8d22ed4d922e6e8eb7f8f51d38187
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.11.17

Release files / supymode-2.4.13-cp312-cp312-macosx_26_0_arm64.whl

Download URL supymode-2.4.13-cp312-cp312-macosx_26_0_arm64.whl
Size 2.3 MB
Tags CPython 3.12 macOS 26.0+ ARM64
SHA-256 checksum
How to use checksums
174df687640c02541b218e884c32893700354ad61ab17d1c790a6493cb1be6e6
BLAKE2b-256 checksum
How to use checksums
9c5a2e117fbd0d3d999ae1297d37bd3d5dfe74b0b010e4fac6d06e9b0c8d8fd7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.11.17

Release files / supymode-2.4.13-cp311-cp311-win_amd64.whl

Download URL supymode-2.4.13-cp311-cp311-win_amd64.whl
Size 2.8 MB
Tags CPython 3.11 Windows x86-64
SHA-256 checksum
How to use checksums
a55963a57bad250b50d20c85faa1015c0a31a46aaf7a80190c648d363be0d080
BLAKE2b-256 checksum
How to use checksums
2416910f6fac49e629e118133b9e2b92891c85bbca7c5c21aac70995fb0a3f09
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.11.17

Release files / supymode-2.4.13-cp311-cp311-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl

Download URL supymode-2.4.13-cp311-cp311-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl
Size 1.1 MB
Tags CPython 3.11 Linux glibc 2.27+ x86-64 Linux glibc 2.28+ x86-64
SHA-256 checksum
How to use checksums
00e7ca03318ad9275e1f42a176451cb6aa159a3e67695fce934732f447f595be
BLAKE2b-256 checksum
How to use checksums
182b344faae2836ee10cef47540079f94c8503a91422caeb0da34c9a1619ed83
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.11.17

Release files / supymode-2.4.13-cp311-cp311-macosx_26_0_arm64.whl

Download URL supymode-2.4.13-cp311-cp311-macosx_26_0_arm64.whl
Size 2.3 MB
Tags CPython 3.11 macOS 26.0+ ARM64
SHA-256 checksum
How to use checksums
2dc9c4ab4046f2440c969e5632cc863398bfe228d9b9b9a8ac0f0335b44d7a32
BLAKE2b-256 checksum
How to use checksums
da41735a4e82578e4d957f60fa14e8f67f8f786012e98ecab339ff62324b3a3d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.11.17

Security for SuPyMode 2.4.13

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

2.4.13 This release

12 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page