A package for light propagation in fiber optics.
Project description
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 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 .
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.7-cp311-cp311-win_amd64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b316a331088c97d08db79a316f8f43a11a1b35b57afe312b9d4fa062bb8df653 |
|
MD5 | 29a62c9e600bfe014d79f1e89d9798e9 |
|
BLAKE2b-256 | 1811cca0248efbd9ca2e7f353e2e604e001497d5c834ae389244853a7f1c3063 |
Hashes for SuPyMode-1.0.7-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 808cf9144bc4f02520d6768aa5da62b904cf8425225d6b9a38e699ca8ed81991 |
|
MD5 | 5d5dfbac617977f409ce57d84e8742ec |
|
BLAKE2b-256 | 2b66b3456fb3a30f2239062b2d90704f820a13a14dc8c2f6e40f8a0e366b9e0d |
Hashes for SuPyMode-1.0.7-cp311-cp311-macosx_10_13_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d733902fe5c6279875d27d4e7ea7e0b471d12f16294c9cf4152b4e2f5bdbb041 |
|
MD5 | 47472447eb966b62e263a47896e9fd09 |
|
BLAKE2b-256 | 2228cca7f11f47fc164a27c7e0fc230b5c2e865f610180d66fb16d967471fc2f |
Hashes for SuPyMode-1.0.7-cp310-cp310-win_amd64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6b357c03561c7a44d6624fdee4ad11119103134df6be771e21b948811fdf66fe |
|
MD5 | 0267df921dcc2545e8e357dd0fcc563a |
|
BLAKE2b-256 | 722bdd3538d8076f7f6b512db47ccbc4d53346cf7396c62517927d140eba026e |
Hashes for SuPyMode-1.0.7-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | fbcacb7dd9157fe0fbbbd97d6eca5437a0d2ab3ae46b10576df7db0347f3844c |
|
MD5 | ee81bc1d21b3fe538f0bf031ec9d4224 |
|
BLAKE2b-256 | fbdc8a53ec6b702634ae4966118391928f06c853714836ae7d38fc5144d1b66c |
Hashes for SuPyMode-1.0.7-cp310-cp310-macosx_10_13_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f4877a503aaf128e89f6bdda48a75f7662fc20b84649f291ab23c60670a23d59 |
|
MD5 | 8331e0ce41bc32d38e67b2c8e47dc592 |
|
BLAKE2b-256 | d5ab5f0efdd05d9d935e6d78f6d42e9e418bf317e8226e5848b889aefd441e69 |