A package for light propagation in fiber optics.
Project description
This project aims to develop an useful tool to simulate propagating mode in fiber optics for all kind of circular-symmetric geometries.
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 PyFiberModes
Manual installation
The following shell commands should do the trick.
>>> git clone https://github.com/MartinPdeS/PyFiberModes.git
>>> cd PyFiberModes
>>> pip install -r requirements/requirements.txt
>>> pip 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/PyFiberModes.git
>>> cd PyFiberModes
>>> pip install -r requirements/requirements.txt
>>> coverage run --source=PyFiberModes --module pytest --verbose tests
>>> coverage report --show-missing
Coding examples
Plenty of examples are available online, I invite you to check the examples section of the documentation.
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.
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 Distribution
Hashes for PyFiberModes-0.3.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5bc00623c0dc3b8320141490d014b3adb1fe0e3df5775394edec2cadb05706b4 |
|
MD5 | 4635225a03261982e31e6573e78770be |
|
BLAKE2b-256 | 3d273afa1f3286ea6bfcb67809acb74ffd7fa7776d905e008be70eab79d86efb |