A package for light propagation in fiber optics.
Project description
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:
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:
cmake (3.16+)
In order to use the SuPyMode Simulator Library, one must have installed the python dependencies:
>>> pip3 install -r requirements.txt
Then, download and install the SuPyMode package:
>>> git clone https://github.com/MartinPdeS/SuPyMode.git
>>> cd SuPyMode && mkdir build && cd build
>>> cmake ..
>>> make install (Linux, MacOs)
>>> cd ..
>>> pip3 install .
Testing
To test localy (with cloning the GitHub repository) you’ll need to install the dependencies and run the coverage command as
>>> git clone https://github.com/MartinPdeS/SuPyMode.git
>>> cd SuPyMode
>>> pip install -r requirements/requirements.txt
>>> coverage run --source=SuPyMode --module pytest --verbose tests
>>> coverage report --show-missing
Contact Information
As of 2021 the project is still under development if you want to collaborate it would be a pleasure. I encourage you to contact me.
PyMieSim was written by Martin Poinsinet de Sivry-Houle .
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distributions
Hashes for SuPyMode-1.0.0-cp311-cp311-win_amd64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e6a07ab5fb005af5d0c6a3b21f8aaca62c3255a0c69017985e9b53cc013627ab |
|
MD5 | 4bf99088bf1bd44f9afea9aef1ec14ad |
|
BLAKE2b-256 | afaeeed0f789c949ccc9c0046d17f41e5ac0cd148c988120f997bb3e8a5bebff |
Hashes for SuPyMode-1.0.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f99119e004ce51de3bdf93dfba50725c8bbd0b94d672d2c8dada7c9c4bfd97a7 |
|
MD5 | 98b222310f146f416bea566d9b5a21d5 |
|
BLAKE2b-256 | 08e244d91a27b09d1c05e0b35d6e2652974b93798bbf6bafdc2199fd670a4525 |
Hashes for SuPyMode-1.0.0-cp311-cp311-macosx_10_13_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ac4af21f2b5684c06b1005084530a5e4042f61c31db406aff7bee0dbe496061e |
|
MD5 | 0ea106840f54000fd0ec720fd143151a |
|
BLAKE2b-256 | f1e2b60529c54b62c02c041edf3f653268bd08a4ee127ed344dc4e60eae0a9ec |
Hashes for SuPyMode-1.0.0-cp310-cp310-win_amd64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f38cc57d7a7ecc879e82c23409731d475e2a264b509b39be21a6714550392d93 |
|
MD5 | 970e536f1368a671c24d74f7dbab384d |
|
BLAKE2b-256 | 8fd9b7c8094f20711fa4d255c92cbdb735debfec66999ff6fba0ba072f61bb36 |
Hashes for SuPyMode-1.0.0-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 726e164763a70927b276cec3ddaa075b54036f09bda167fea2f1833b763e6147 |
|
MD5 | bd31d717ac97b5a295784de88c7cbcf0 |
|
BLAKE2b-256 | abfcd17d69726ed9c52005d5eb1d250458c1f20cf891c16d77344af41958f0f5 |
Hashes for SuPyMode-1.0.0-cp310-cp310-macosx_10_13_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 471d90d196b6a74248913ef5a36b53b4a0cc96ec321eff634be89c5be1b26d60 |
|
MD5 | 539ead619021bf652274efa10a6bdd63 |
|
BLAKE2b-256 | d5011591deef949c914fe64e06817e19c4cba738e71ca6fa2960d835fb2dac5e |