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.11

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.11
File Actions
supymode-2.4.11-cp314-cp314-win_amd64.whl CPython 3.14 CPython 3.14 Windows x86-64 Details for supymode-2.4.11-cp314-cp314-win_amd64.whl
supymode-2.4.11-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.11-cp314-cp314-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl
supymode-2.4.11-cp314-cp314-macosx_26_0_arm64.whl CPython 3.14 CPython 3.14 macOS 26.0+ ARM64 Details for supymode-2.4.11-cp314-cp314-macosx_26_0_arm64.whl
supymode-2.4.11-cp313-cp313-win_amd64.whl CPython 3.13 CPython 3.13 Windows x86-64 Details for supymode-2.4.11-cp313-cp313-win_amd64.whl
supymode-2.4.11-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.11-cp313-cp313-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl
supymode-2.4.11-cp313-cp313-macosx_26_0_arm64.whl CPython 3.13 CPython 3.13 macOS 26.0+ ARM64 Details for supymode-2.4.11-cp313-cp313-macosx_26_0_arm64.whl
supymode-2.4.11-cp312-cp312-win_amd64.whl CPython 3.12 CPython 3.12 Windows x86-64 Details for supymode-2.4.11-cp312-cp312-win_amd64.whl
supymode-2.4.11-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.11-cp312-cp312-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl
supymode-2.4.11-cp312-cp312-macosx_26_0_arm64.whl CPython 3.12 CPython 3.12 macOS 26.0+ ARM64 Details for supymode-2.4.11-cp312-cp312-macosx_26_0_arm64.whl
supymode-2.4.11-cp311-cp311-win_amd64.whl CPython 3.11 CPython 3.11 Windows x86-64 Details for supymode-2.4.11-cp311-cp311-win_amd64.whl
supymode-2.4.11-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.11-cp311-cp311-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl
supymode-2.4.11-cp311-cp311-macosx_26_0_arm64.whl CPython 3.11 CPython 3.11 macOS 26.0+ ARM64 Details for supymode-2.4.11-cp311-cp311-macosx_26_0_arm64.whl

Total release size: 24.9 MB

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

Download URL supymode-2.4.11-cp314-cp314-win_amd64.whl
Size 3.0 MB
Tags CPython 3.14 Windows x86-64
SHA-256 checksum
How to use checksums
272a2e53af63b80f37f9ad92754ac23babdc67135671ad09e3bdb88ebb40c295
BLAKE2b-256 checksum
How to use checksums
16a86972e34c7a546e94d3b0df1ff80e1c90c4baabf16f633f88abcd71c55d83
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.11-cp314-cp314-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl

Download URL supymode-2.4.11-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
f2e308897834368b86539d3fcd4de2d8a418c2270ab44d103aaba3202189945e
BLAKE2b-256 checksum
How to use checksums
3e8b5d0971f259a9a3dd7963d2c3a1eed991d8f0adda0aeb893729545510764d
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.11-cp314-cp314-macosx_26_0_arm64.whl

Download URL supymode-2.4.11-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
f1909b057ff0cf40518e114d198483b54513dc23c5a51eccedebaaa95e0630f1
BLAKE2b-256 checksum
How to use checksums
273da2026b4041ed7296ef693fa1c0da7b466ea5f7b4cbd91e2a19e381190a13
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.11-cp313-cp313-win_amd64.whl

Download URL supymode-2.4.11-cp313-cp313-win_amd64.whl
Size 2.9 MB
Tags CPython 3.13 Windows x86-64
SHA-256 checksum
How to use checksums
728a895976c44f11a9fd6d7d6349436f9c6b20be06c62efe019e2f303ba6a665
BLAKE2b-256 checksum
How to use checksums
ce34910ddb837b31b3265cf137bc4bdc9c5dcc9fd80144a38673601666a7a587
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.11-cp313-cp313-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl

Download URL supymode-2.4.11-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
d14c21a5d4227d617e66506f50ac207a25caa426a39044e337d9d3d122987191
BLAKE2b-256 checksum
How to use checksums
addf64b89c1cf24eeba807cfcce74bc9fe98b9d1f50ef9a4aa1bb5c1894dd25f
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.11-cp313-cp313-macosx_26_0_arm64.whl

Download URL supymode-2.4.11-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
91db62793290b12980d53053d813aa060aba65a683fd46ccccf65c107397389a
BLAKE2b-256 checksum
How to use checksums
08270bec7d56fff2641a42e1ef94c9cb2b326f7697f76bd6b441b6edb4d6c213
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.11-cp312-cp312-win_amd64.whl

Download URL supymode-2.4.11-cp312-cp312-win_amd64.whl
Size 2.9 MB
Tags CPython 3.12 Windows x86-64
SHA-256 checksum
How to use checksums
cfd8459f9ef360f800a0271daeb13dd34e2253ff331b2bbda91bb72cca4d632b
BLAKE2b-256 checksum
How to use checksums
d8097ef7dc8c78bc3a345a9e9f3106e4eb86e213c84c156dad72c29f0aa52cdd
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.11-cp312-cp312-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl

Download URL supymode-2.4.11-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
31e845d38f0dc10becd7433060ef8f63a8ec529a5cc0387ee1e34d88d7c4a583
BLAKE2b-256 checksum
How to use checksums
a9bd979cbcdf890ed7225be7852872637fa8d97de48a605104dd1b7add878a8b
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.11-cp312-cp312-macosx_26_0_arm64.whl

Download URL supymode-2.4.11-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
a9eef94806d56bb23ceeed0410444e9c81b418c75eee3a5ca1c245409879dcff
BLAKE2b-256 checksum
How to use checksums
d59f598fe359f82c5826b38333b0751711b0ace4516a4bafd365cc91e0ce3510
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.11-cp311-cp311-win_amd64.whl

Download URL supymode-2.4.11-cp311-cp311-win_amd64.whl
Size 2.8 MB
Tags CPython 3.11 Windows x86-64
SHA-256 checksum
How to use checksums
eb9b4539879f494afa3df40d2a134a488a2fcacde87848fd5d05a8a6f0589034
BLAKE2b-256 checksum
How to use checksums
0230a144431dd935fea03b673a07ab966d79e140b6114663f15564a4ac391b32
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.11-cp311-cp311-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl

Download URL supymode-2.4.11-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
a422d647565ebf325344cfdc2b11f0ea99029664ad8dcd28556d56e1a4cec576
BLAKE2b-256 checksum
How to use checksums
2f8a727e10813caf6d1dc15319a7c3665d3de64a5306d3b2fd053d9b6e4c51a2
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.11-cp311-cp311-macosx_26_0_arm64.whl

Download URL supymode-2.4.11-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
71da1b1e0bcadc1287e71394e4e39da30f6ee862c565ed1d8d7c1b76787c8a6e
BLAKE2b-256 checksum
How to use checksums
3b0dd8cc8c6ccf6cb9f9a69e35bcae2ba2d5f73ec78728564d98eedf27340453
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.11

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.11 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