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

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

Total release size: 24.9 MB

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

Download URL supymode-2.4.7-cp314-cp314-win_amd64.whl
Size 3.0 MB
Tags CPython 3.14 Windows x86-64
SHA-256 checksum
How to use checksums
f7805070a2243b47e5d946d149cadd4ab623cb6f79d1a18bee87810ce70acfef
BLAKE2b-256 checksum
How to use checksums
37542ab2c40b3fefe8ed55867271c86b3235dcebbcfebc14a2f6013e4202afec
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.7-cp314-cp314-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl

Download URL supymode-2.4.7-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
872f63f4b94f12ebb2f0b413aeea861a8423e1e9f754ce1657de2fadbbefb4a3
BLAKE2b-256 checksum
How to use checksums
fdf800eaeb1db7ad0247ddd7ab422e0c8602156551e642b85e7f2f71715c1b1d
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.7-cp314-cp314-macosx_26_0_arm64.whl

Download URL supymode-2.4.7-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
34d2c031d014bef024f7f300ec3e85c38858f55f9c787fdcd86080ebc1eede38
BLAKE2b-256 checksum
How to use checksums
98465a31c5268930af5812e296a8c4688a7c643bd07ef5a30ab51cc27718b814
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.7-cp313-cp313-win_amd64.whl

Download URL supymode-2.4.7-cp313-cp313-win_amd64.whl
Size 2.9 MB
Tags CPython 3.13 Windows x86-64
SHA-256 checksum
How to use checksums
e712c75859eecafb7278d9974ca8b386bd249420178514f8e94515711d640789
BLAKE2b-256 checksum
How to use checksums
3d82c22eca2ade2456c85ac0f5043c228137c19328846f85c9f573712aacf3ef
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.7-cp313-cp313-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl

Download URL supymode-2.4.7-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
8700538fbfdec068f43635a349705e40599fb8e68f0a96ba1be8113e0e46113f
BLAKE2b-256 checksum
How to use checksums
e9ede6a536def50bd8cda2370b21df4d73316bae1bfa225af50808b6db4e6329
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.7-cp313-cp313-macosx_26_0_arm64.whl

Download URL supymode-2.4.7-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
922b8ea481ca86eefe9bcb9542f6631bfe07a165ba5803a88909744b0ef4b2a9
BLAKE2b-256 checksum
How to use checksums
e99ba88228b10e94bf126cf894035c5e63413a9db2ad5fe5f8d2fa03e0238278
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.7-cp312-cp312-win_amd64.whl

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

Download URL supymode-2.4.7-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
8ae5022887e9752c266e6ba981b7cc6decd89b4d0dec6b14c9b36b3e99def757
BLAKE2b-256 checksum
How to use checksums
08b0c1224193cdfa4d29f6ec0c67c8321693b074c226791f0a3ef2be3b50de90
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.7-cp312-cp312-macosx_26_0_arm64.whl

Download URL supymode-2.4.7-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
3598e804797329f50bbc2515b0290d3b83f7e9040590dd0bfa33020c5bdc2da1
BLAKE2b-256 checksum
How to use checksums
ce287d594861165bc11049cde57d12cfccf6e0bf9734e11c7dd7d5e241c3c7f0
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.7-cp311-cp311-win_amd64.whl

Download URL supymode-2.4.7-cp311-cp311-win_amd64.whl
Size 2.8 MB
Tags CPython 3.11 Windows x86-64
SHA-256 checksum
How to use checksums
100892ff397e215845b50fe6d36c06c68df59b8d8e4ade216d142298c10f834b
BLAKE2b-256 checksum
How to use checksums
1ef89b853048202cac245dd1f3198dc66e2b6043a09c488ed1d38f7449519c63
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.7-cp311-cp311-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl

Download URL supymode-2.4.7-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
f0023886209d1756a9f359cf15bfd5d7a6be7381c5beba7e7580abeeb51622a2
BLAKE2b-256 checksum
How to use checksums
56aedd2651b4d1055baef0729134231f9781b7ad972dc760b121bbfaa6fab551
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.7-cp311-cp311-macosx_26_0_arm64.whl

Download URL supymode-2.4.7-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
5f01b5b9811e72ed48bee1e3d9ea450c648f49a74a0787c13b0d1440e02b3f64
BLAKE2b-256 checksum
How to use checksums
f75ab51ceca4c424a32d4e39b5c71ddf48f5e9dac16d088c94125c218044e34a
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.7

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