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.
All the latest available documentation is available here or you can click the following badge:
The package have been uploaded as wheel for a few OS (Linux, MacOS) and need Python 3.10. As such, with the adequate configuration one can simply do
>>> pip3 install SuPyMode
To install manually (os independent) you will need to install:
- cmake (3.16+)
Then, download and install the SuPyMode package:
>>> git clone --recurse-submodules https://github.com/MartinPdeS/SuPyMode.git
>>> cd SuPyMode && mkdir build && cd build
>>> cmake ..
>>> cmake --build .
>>> cd ..
>>> pip3 install .
Make sure to install both coverage and pytest using pip3 install coverage pytest
. To test locally (with cloning the GitHub repository) you'll need to install the dependencies and run the coverage command as
>>> git clone --recurse-submodules https://github.com/MartinPdeS/SuPyMode.git
>>> cd SuPyMode
>>> pip3 install PyFiberModes
>>> coverage run --source=SuPyMode --module pytest --verbose tests
>>> coverage report --show-missing
As of 2023 the project is still under development if you want to collaborate it would be a pleasure. I encourage you to contact me.
SuPyMode was written by Martin Poinsinet de Sivry-Houle .