PyFiberModes 0.4.0.post0

A package for light propagation in fiber optics.

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 .

Email:[e-mail] .