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 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.1-cp311-cp311-win_amd64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a1ab3dbb80d323a1526d03adfca8f1190eb2c94dea4e9e275b77b17bae497199 |
|
MD5 | 93de0e559fcec33136701c4d72d8d51a |
|
BLAKE2b-256 | 1df44121d683fd42281041b33c0b0fd3f93127afbf82b40f599a84f7ef746fb0 |
Hashes for SuPyMode-1.0.1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d30e714f4d48fea7906050ab0ff9af0d08380e2f830dcfd6668fe7fe8695d80c |
|
MD5 | c658e1472d229404bb21f938e1748e58 |
|
BLAKE2b-256 | 77f3ee4ad9450738550a065fa29f69e24be76270630510511bd9ce07719207c7 |
Hashes for SuPyMode-1.0.1-cp311-cp311-macosx_10_13_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a82952170c4af787a837543e67494a942035428d215cb1be4cb89df9856e6712 |
|
MD5 | e98819c0a479a912671288a92cf4f289 |
|
BLAKE2b-256 | ceda446033e1707b1ec36e4b2fef9ab4ba49f4f937f2739e213fc25994a5e543 |
Hashes for SuPyMode-1.0.1-cp310-cp310-win_amd64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0b7e29d666e6fb81f9dc475798a350ad2044fdca0f7af033e0c99da504c29f90 |
|
MD5 | cdb9838a5ad5d6eb3a87c014922f3d7c |
|
BLAKE2b-256 | e94f4f0d7ca55845adfaaf9d3783d668e5b672c136f8878145ea9634189004a6 |
Hashes for SuPyMode-1.0.1-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | aae59c6a994b00b0876a2c4e1217e86821eac5b23163f063e4cffcd1a79b0092 |
|
MD5 | 765fefc29677bb6a9bb8a5018e56f836 |
|
BLAKE2b-256 | 2203951a36eeb3fb3778043eabdf51e45ce95f2eca08a8c1152510b16cf38e2d |
Hashes for SuPyMode-1.0.1-cp310-cp310-macosx_10_13_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5a6014455fd551b073660011220d813c3d535a125d0b9447278bff15e6cc0879 |
|
MD5 | b14ab7224eb038407cb8b7292b8ae2d8 |
|
BLAKE2b-256 | 265ba57781347c76a29d59d7ffc1aa970547029e9d94cf6f43bbb2076b52878e |