Skip to content

Python package for light propagation in fiber optics components

License

Notifications You must be signed in to change notification settings

MartinPdeS/SuPyMode

Folders and files

NameName
Last commit message
Last commit date

Latest commit

09af01b · Dec 12, 2024

History

73 Commits
Dec 10, 2024
Dec 12, 2024
Dec 11, 2024
Nov 15, 2024
Dec 9, 2024
Oct 23, 2024
Oct 23, 2024
Dec 9, 2024
Dec 9, 2024
Aug 21, 2024
Dec 9, 2024
Oct 12, 2023
Aug 21, 2024
Oct 24, 2024
Dec 9, 2024
Oct 24, 2024
Dec 10, 2024

Repository files navigation

SuPyMode

python Documentation Status Citation Unittest coverage PyPi PyPi_download colab

some image

Propagation of mode in an adiabatic 2x1 modally-specific photonic lantern.

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.


Documentation

All the latest available documentation is available here or you can click the following badge:

Documentation Status


Installation

Pip installation

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

Manual installation

To install manually (os independent) you will need to install:

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

Testing

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

Contact Information

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 .

Email:[email protected] .