Metadata-Version: 2.1
Name: PyFiberModes
Version: 0.2.31
Summary: A package for light propagation in fiber optics.
Home-page: https://github.com/MartinPdeS/PyFiberModes
Author: Martin Poinsinet de Sivry
Author-email: Martin.poinsinet.de.sivry@gmail.com
License: MIT
Platform: unix
Platform: linux
Platform: osx
Platform: windows
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Telecommunications Industry
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Topic :: Scientific/Engineering :: Physics
Description-Content-Type: text/x-rst
Requires-Dist: MPSPlots
Requires-Dist: PyFinitDiff
Requires-Dist: MPSTools
Requires-Dist: numpy
Requires-Dist: scipy
Provides-Extra: development
Requires-Dist: jinja2 ==3.1.2 ; extra == 'development'
Requires-Dist: numpydoc ==1.5.0 ; extra == 'development'
Requires-Dist: sphinx >5.1.1 ; extra == 'development'
Requires-Dist: sphinx-gallery ==0.11.1 ; extra == 'development'
Requires-Dist: sphinx-rtd-theme ==1.0.0 ; extra == 'development'
Requires-Dist: numpydoc ; extra == 'development'
Requires-Dist: pydata-sphinx-theme ; extra == 'development'
Requires-Dist: pytest >=0.6 ; extra == 'development'
Requires-Dist: pytest-cov >=2.0 ; extra == 'development'
Requires-Dist: pytest-json-report ; extra == 'development'
Requires-Dist: mypy >=0.910 ; extra == 'development'
Requires-Dist: flake8 >=3.9 ; extra == 'development'
Requires-Dist: tox >=3.24 ; extra == 'development'
Requires-Dist: coverage ; extra == 'development'
Provides-Extra: documentation
Requires-Dist: jinja2 ==3.1.2 ; extra == 'documentation'
Requires-Dist: numpydoc ==1.5.0 ; extra == 'documentation'
Requires-Dist: sphinx >5.1.1 ; extra == 'documentation'
Requires-Dist: sphinx-gallery ==0.11.1 ; extra == 'documentation'
Requires-Dist: sphinx-rtd-theme ==1.0.0 ; extra == 'documentation'
Requires-Dist: numpydoc ; extra == 'documentation'
Requires-Dist: pydata-sphinx-theme ; extra == 'documentation'
Provides-Extra: testing
Requires-Dist: pytest >=0.6 ; extra == 'testing'
Requires-Dist: pytest-cov >=2.0 ; extra == 'testing'
Requires-Dist: pytest-json-report ; extra == 'testing'
Requires-Dist: mypy >=0.910 ; extra == 'testing'
Requires-Dist: flake8 >=3.9 ; extra == 'testing'
Requires-Dist: tox >=3.24 ; extra == 'testing'
Requires-Dist: coverage ; extra == 'testing'

PyFiberModes
============

|python|
|docs|
|Unittest|
|PyPi|
|PyPi_download|




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 <https://pyfibermodes.readthedocs.io/en/latest/>`_ or you can click the following badge:

|docs|


----


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

.. code-block:: python

   >>> pip3 install PyFiberModes



Manual installation
*******************
The following shell commands should do the trick.

.. code-block:: python

    >>> git clone https://github.com/MartinPdeS/PyFiberModes.git
    >>> cd PyFiberModes
    >>> pip install -r requirements/requirements.txt
    >>> pip install .

----


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 <https://github.com/MartinPdS>`_  .

Email:`martin.poinsinet-de-sivry@polymtl.ca <mailto:martin.poinsinet-de-sivry@polymtl.ca?subject=PyFiberModes>`_ .


.. |python| image:: https://img.shields.io/pypi/pyversions/pyfibermodes.svg
   :target: https://www.python.org/

.. |docs| image:: https://readthedocs.org/projects/pyfibermodes/badge/?version=latest
   :target: https://pyfibermodes.readthedocs.io/en/latest/
   :alt: Documentation Status

.. |Unittest| image:: https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/MartinPdeS/f0955be398d59efac69042c1b0fbece2/raw/6b0b0ab45384e6c451f008c91f684bc8f1f6b76d/PyFiberModescoverage_badge.json

.. |PyPi| image:: https://badge.fury.io/py/PyFiberModes.svg
   :target: https://pypi.org/project/PyFiberModes/

.. |PyPi_download| image:: https://img.shields.io/pypi/dm/PyFiberModes.svg
   :target: https://pypi.org/project/PyFiberModes/



