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

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

Total release size: 24.9 MB

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

Download URL supymode-2.4.14-cp314-cp314-win_amd64.whl
Size 3.0 MB
Tags CPython 3.14 Windows x86-64
SHA-256 checksum
How to use checksums
6698f996ee1a26f436dbbc30cee159cf1471c99b9206a852038d3980909ace3d
BLAKE2b-256 checksum
How to use checksums
58da4c1bff643a66eedabf378e517a02c9c098c5e594fef0268350c33b4442ba
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.11.18

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

Download URL supymode-2.4.14-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
a00260b8e608e4fdb9181466e3d1a2ae89f1030773a87ffa7de82ebd2bbe9dc1
BLAKE2b-256 checksum
How to use checksums
496c3787823630ea28bcd5c7440ee371b186f26d0056b7f913aa0b5b42d88f68
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.11.18

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

Download URL supymode-2.4.14-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
51dadfaaedd2342b81ce5bb72b57675b8a0ec5b1e1a5ae1a7e26b16025d7ffb2
BLAKE2b-256 checksum
How to use checksums
a7e1834db91220fdbe7e6499ba28d4b15288cef06709725d6fdcd2b32e975c7e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.11.18

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

Download URL supymode-2.4.14-cp313-cp313-win_amd64.whl
Size 2.9 MB
Tags CPython 3.13 Windows x86-64
SHA-256 checksum
How to use checksums
10c9ccb9f2e87ba390bb209cd2ae2c62d673341fe7ed5e20b77f574559213054
BLAKE2b-256 checksum
How to use checksums
73360a4cda91650a84799595d8c07932c94537c7fec7e851314ccc46ce700d0c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.11.18

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

Download URL supymode-2.4.14-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
5b80644ffdc09b28a50b2801e1675d7076aa382e491180f91fbba18d404d1c01
BLAKE2b-256 checksum
How to use checksums
f11f1b544bbb2d5ca669e493e7d8b2184cee02969c7f84710da5c5d16638d19f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.11.18

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

Download URL supymode-2.4.14-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
d7077f7c4d215a1ef3d6411cb7b5ea22e7f9f7cdae67f342e7d2f0a075d717d9
BLAKE2b-256 checksum
How to use checksums
5de015fd268ac291eddbf76d11e17fec677803b131b415a9119704ff53701d1d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.11.18

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

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

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

Download URL supymode-2.4.14-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
c98c5a35d78a218b9f766916cb803689fe382af575f9e2d4830eed64db5a4853
BLAKE2b-256 checksum
How to use checksums
4fd05922787928c56f182b527ed89b9c01dd21e23f86aa4bb99defc4b6408d70
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.11.18

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

Download URL supymode-2.4.14-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
5a1a1ecc60cb73216be4bc8ca45f79b88dcf1f46c8267832847c80635c69ffc2
BLAKE2b-256 checksum
How to use checksums
06dcd4d61639969d0b645e876e459f57cbe3570f2180b894ee6b277d8b91ffa2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.11.18

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

Download URL supymode-2.4.14-cp311-cp311-win_amd64.whl
Size 2.8 MB
Tags CPython 3.11 Windows x86-64
SHA-256 checksum
How to use checksums
4cb9eb6ed470a1cb92dc7c7d24e573ed8e45ca061b6f47f217e68bf0553c67d4
BLAKE2b-256 checksum
How to use checksums
7a2e8eb680e45a3ccb77970eda6762ac8209ce1ab30f99bb06e26060b95a6116
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.11.18

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

Download URL supymode-2.4.14-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
6929590e0072f8b1743a59a90f4417c4260ab196b0df512d9541becae26a6449
BLAKE2b-256 checksum
How to use checksums
692b5feacf20444a597bd54bd89bb4681910d8a7e7346469c60f597d2f4b7bde
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.11.18

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

Download URL supymode-2.4.14-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
ce12156cf4fb0a717449f2d91838426687787c94895cb7cecda819117dbf75ff
BLAKE2b-256 checksum
How to use checksums
8bdce62af558be891ceec66930e505bfdd77476aef561069d694865972c83355
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.11.18

Security for SuPyMode 2.4.14

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