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

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.9
File Actions
supymode-2.4.9-cp314-cp314-win_amd64.whl CPython 3.14 CPython 3.14 Windows x86-64 Details for supymode-2.4.9-cp314-cp314-win_amd64.whl
supymode-2.4.9-cp314-cp314-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl CPython 3.14 CPython 3.14 Linux glibc 2.27+ x86-64, Linux glibc 2.28+ x86-64 Details for supymode-2.4.9-cp314-cp314-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl
supymode-2.4.9-cp314-cp314-macosx_26_0_arm64.whl CPython 3.14 CPython 3.14 macOS 26.0+ ARM64 Details for supymode-2.4.9-cp314-cp314-macosx_26_0_arm64.whl
supymode-2.4.9-cp313-cp313-win_amd64.whl CPython 3.13 CPython 3.13 Windows x86-64 Details for supymode-2.4.9-cp313-cp313-win_amd64.whl
supymode-2.4.9-cp313-cp313-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl CPython 3.13 CPython 3.13 Linux glibc 2.27+ x86-64, Linux glibc 2.28+ x86-64 Details for supymode-2.4.9-cp313-cp313-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl
supymode-2.4.9-cp313-cp313-macosx_26_0_arm64.whl CPython 3.13 CPython 3.13 macOS 26.0+ ARM64 Details for supymode-2.4.9-cp313-cp313-macosx_26_0_arm64.whl
supymode-2.4.9-cp312-cp312-win_amd64.whl CPython 3.12 CPython 3.12 Windows x86-64 Details for supymode-2.4.9-cp312-cp312-win_amd64.whl
supymode-2.4.9-cp312-cp312-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl CPython 3.12 CPython 3.12 Linux glibc 2.27+ x86-64, Linux glibc 2.28+ x86-64 Details for supymode-2.4.9-cp312-cp312-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl
supymode-2.4.9-cp312-cp312-macosx_26_0_arm64.whl CPython 3.12 CPython 3.12 macOS 26.0+ ARM64 Details for supymode-2.4.9-cp312-cp312-macosx_26_0_arm64.whl
supymode-2.4.9-cp311-cp311-win_amd64.whl CPython 3.11 CPython 3.11 Windows x86-64 Details for supymode-2.4.9-cp311-cp311-win_amd64.whl
supymode-2.4.9-cp311-cp311-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl CPython 3.11 CPython 3.11 Linux glibc 2.27+ x86-64, Linux glibc 2.28+ x86-64 Details for supymode-2.4.9-cp311-cp311-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl
supymode-2.4.9-cp311-cp311-macosx_26_0_arm64.whl CPython 3.11 CPython 3.11 macOS 26.0+ ARM64 Details for supymode-2.4.9-cp311-cp311-macosx_26_0_arm64.whl

Total release size: 24.9 MB

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

Download URL supymode-2.4.9-cp314-cp314-win_amd64.whl
Size 3.0 MB
Tags CPython 3.14 Windows x86-64
SHA-256 checksum
How to use checksums
30b367abf20a4c04a783a530cd02502a1906f13c3987c7749e85c2914c097f9a
BLAKE2b-256 checksum
How to use checksums
672491860d28f32bd245b1761eccdb86b13a830aaf93f0016c6ecc76b1d7d628
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.9-cp314-cp314-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl

Download URL supymode-2.4.9-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
9b055796eba344e9a74fad01efda31e628349c0cc883407cad0ac1bb032b8817
BLAKE2b-256 checksum
How to use checksums
cfd8b22c69586d95602ad5f8737e6fde44e06526b7f3d86255e877080a8a12b9
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.9-cp314-cp314-macosx_26_0_arm64.whl

Download URL supymode-2.4.9-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
c35ef4a078b477578d167ebd5a0dc78701df555bbb46e82f06fd7cbb0624034c
BLAKE2b-256 checksum
How to use checksums
42e52c61d5befd742692b887706300173b40c47dc24e769034b5d525c86e47ac
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.9-cp313-cp313-win_amd64.whl

Download URL supymode-2.4.9-cp313-cp313-win_amd64.whl
Size 2.9 MB
Tags CPython 3.13 Windows x86-64
SHA-256 checksum
How to use checksums
d69b934a02be614b4a36e5ad6cb3e7d58717d2de3ec8f60db9861360a398eafc
BLAKE2b-256 checksum
How to use checksums
7431985af099303138bdfb18b525f63f76922d81e589a455bb2913386e595867
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.9-cp313-cp313-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl

Download URL supymode-2.4.9-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
565d1bcdb72d0b628a4984304132c7c9e97d295a3ce3fdaeb2e05d9c5211720d
BLAKE2b-256 checksum
How to use checksums
9e334066bfa885c60da49d3bb12ca533f01a9902c4c9857c274375a3db60216b
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.9-cp313-cp313-macosx_26_0_arm64.whl

Download URL supymode-2.4.9-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
3fb4f3934f36e6553a155b652e23cd6780155c8f0ef9ac1be067b87503d2055e
BLAKE2b-256 checksum
How to use checksums
25a36064f2dbdedab21839d3d89e1f38eea8b4ba34d4e58d384b53b7fbf6596f
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.9-cp312-cp312-win_amd64.whl

Download URL supymode-2.4.9-cp312-cp312-win_amd64.whl
Size 2.9 MB
Tags CPython 3.12 Windows x86-64
SHA-256 checksum
How to use checksums
0162bde79a10d9af66704208799222e125e1329c651e9d8f6b4094d8450bead6
BLAKE2b-256 checksum
How to use checksums
6b9fce99d20b023e617e272e0a83faff25270aa4ad39002edffa32d37905d406
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.9-cp312-cp312-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl

Download URL supymode-2.4.9-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
182e06dc4a64b028bf3248d3ba1efad06a43be764ba03126f50efd7997083db0
BLAKE2b-256 checksum
How to use checksums
32b46b0cde6c74ea8a46f806caf894cdf2870169f61a3ab34f02a8a5b9178e6b
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.9-cp312-cp312-macosx_26_0_arm64.whl

Download URL supymode-2.4.9-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
5f85bcd9d7f218c12b594405594f5f9b187d3631229e1ac4a51180c92086f67a
BLAKE2b-256 checksum
How to use checksums
32ebe7cd9dd5a1bf8df1b5a5d7d9f3c6dc1a58bad304beb56f2ef57bbd880682
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.9-cp311-cp311-win_amd64.whl

Download URL supymode-2.4.9-cp311-cp311-win_amd64.whl
Size 2.8 MB
Tags CPython 3.11 Windows x86-64
SHA-256 checksum
How to use checksums
01515c311bb55fd254c52f30009e60777888625cb338885f5cc91dcc1a753670
BLAKE2b-256 checksum
How to use checksums
512a9a212bc7d7e60f8e15436a5ba7c4e3e21b28ca1260f43fef526ffaf93839
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.9-cp311-cp311-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl

Download URL supymode-2.4.9-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
5b368d34745d1e6f69ec333de64b522979cdb347d8c966e01b5511d71958a2a0
BLAKE2b-256 checksum
How to use checksums
56c8ca64e2c70d2b8f2475a96f9443132deb07175184eaae3b6ee8bf313cc2ad
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.9-cp311-cp311-macosx_26_0_arm64.whl

Download URL supymode-2.4.9-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
371aa1786994854ff68490262053dde8ee7b0beb868bcf9c99b8b6303e430c58
BLAKE2b-256 checksum
How to use checksums
b1f089049acb4a30db9959bfa8e5996d2626a34ebf09025308a8763d880001de
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.9

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