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.6-cp311-cp311-win_amd64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8c7f594b24c85167fd83caf1561131ba1736754512aafc360abef371c4b6f5e8 |
|
MD5 | 7eca95c04975a4a67c7b0e16eaeeeaeb |
|
BLAKE2b-256 | f3ac13645d7cb265c9b58ddf836f52564b53f9bb5cdc23cb6154d6911a37bcaa |
Hashes for SuPyMode-1.0.6-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a81b45244f1e27f761b914c92a5bce044f3884437d3bd343b492ac8e7b134dc9 |
|
MD5 | 3dfeadefea7850eaf371489e1cb6a2ff |
|
BLAKE2b-256 | 72cdf61149b7cb5cfbf943d70fa15babf10698dcbd3ae553fbd22e787435e6dc |
Hashes for SuPyMode-1.0.6-cp311-cp311-macosx_10_13_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | bdb1d786b1f0b8b90640ccf77a95b85d19d912e86ec7f1fabf08b932d89dd8bd |
|
MD5 | 5602a0e5a5f1b326c8f0cd8548d44971 |
|
BLAKE2b-256 | 83e18c6d80a17b072de7715285fce01bc99bfd53544f7842a1e61d04a853c443 |
Hashes for SuPyMode-1.0.6-cp310-cp310-win_amd64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 50234d46c15684128015b48e9c4c7ac3695885a5b0a97d050e4e0e6e94293e8f |
|
MD5 | 0421798066874028001a377bde0e9ed4 |
|
BLAKE2b-256 | e19ff9ea46246c930753fb77826c51f2c01247287a8ff14f1a4e95ad6a4b779c |
Hashes for SuPyMode-1.0.6-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 364f31ed2ddaeabb4f19579be664b36436f0c815e0e558fa07c0d6dbd20fa0f5 |
|
MD5 | a7f53a2b897675c6d2fd92a94e2a5212 |
|
BLAKE2b-256 | 2c9fd22c36a05880d57f8b47673afdafbb6bde04a3baa12a26838038103f44b7 |
Hashes for SuPyMode-1.0.6-cp310-cp310-macosx_10_13_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b5a8f50bcf9818e571efc3c21024da229df099284dcfb72eec30ee9e381823cf |
|
MD5 | 87a2286bac73b55881326d794cb5aa44 |
|
BLAKE2b-256 | abaea3df9be9019316cedd6b4d3feed6c8ea463ec7df09951a1cab7784db9532 |