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 .
----
Testing
*******
To test localy (with cloning the GitHub repository) you'll need to install the dependencies and run the coverage command as
.. code:: python
>>> 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 <https://pyfibermodes.readthedocs.io/en/master/gallery/index.html>`_
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 <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/4c502d1ed25ca76bf1a73e2374d40960dae7e2dc/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://pypistats.org/packages/pyfibermodes
Raw data
{
"_id": null,
"home_page": "https://github.com/MartinPdeS/PyFiberModes",
"name": "PyFiberModes",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "Martin Poinsinet de Sivry",
"author_email": "Martin.poinsinet.de.sivry@gmail.com",
"download_url": "",
"platform": "unix",
"description": "PyFiberModes\n============\n\n|python|\n|docs|\n|Unittest|\n|PyPi|\n|PyPi_download|\n\n\n\n\nThis project aims to develop an useful tool to simulate propagating mode in fiber optics for all kind of circular-symmetric geometries.\n\n----\n\nDocumentation\n**************\nAll the latest available documentation is available `here <https://pyfibermodes.readthedocs.io/en/latest/>`_ or you can click the following badge:\n\n|docs|\n\n\n----\n\n\nInstallation\n------------\n\n\nPip installation\n****************\n\nThe package have been uploaded as wheel for a few OS (Linux, MacOS) and need Python 3.10.\nAs such, with the adequate configuration one can simply do\n\n.. code-block:: python\n\n >>> pip3 install PyFiberModes\n\n\n\nManual installation\n*******************\nThe following shell commands should do the trick.\n\n.. code-block:: python\n\n >>> git clone https://github.com/MartinPdeS/PyFiberModes.git\n >>> cd PyFiberModes\n >>> pip install -r requirements/requirements.txt\n >>> pip install .\n\n----\n\nTesting\n*******\n\nTo test localy (with cloning the GitHub repository) you'll need to install the dependencies and run the coverage command as\n\n.. code:: python\n\n >>> git clone https://github.com/MartinPdeS/PyFiberModes.git\n >>> cd PyFiberModes\n >>> pip install -r requirements/requirements.txt\n >>> coverage run --source=PyFiberModes --module pytest --verbose tests\n >>> coverage report --show-missing\n\n----\n\n\n\nCoding examples\n***************\nPlenty of examples are available online, I invite you to check the `examples <https://pyfibermodes.readthedocs.io/en/master/gallery/index.html>`_\nsection of the documentation.\n\n\n----\n\n\nContact Information\n*******************\n\nAs of 2023 the project is still under development if you want to collaborate it would be a pleasure. I encourage you to contact me.\n\nPyMieSim was written by `Martin Poinsinet de Sivry-Houle <https://github.com/MartinPdS>`_ .\n\nEmail:`martin.poinsinet-de-sivry@polymtl.ca <mailto:martin.poinsinet-de-sivry@polymtl.ca?subject=PyFiberModes>`_ .\n\n\n.. |python| image:: https://img.shields.io/pypi/pyversions/pyfibermodes.svg\n :target: https://www.python.org/\n\n.. |docs| image:: https://readthedocs.org/projects/pyfibermodes/badge/?version=latest\n :target: https://pyfibermodes.readthedocs.io/en/latest/\n :alt: Documentation Status\n\n.. |Unittest| image:: https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/MartinPdeS/f0955be398d59efac69042c1b0fbece2/raw/4c502d1ed25ca76bf1a73e2374d40960dae7e2dc/PyFiberModescoverage_badge.json\n\n.. |PyPi| image:: https://badge.fury.io/py/PyFiberModes.svg\n :target: https://pypi.org/project/PyFiberModes/\n\n.. |PyPi_download| image:: https://img.shields.io/pypi/dm/PyFiberModes.svg\n :target: https://pypistats.org/packages/pyfibermodes\n\n\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A package for light propagation in fiber optics.",
"version": "0.3.0",
"project_urls": {
"Homepage": "https://github.com/MartinPdeS/PyFiberModes"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7f5ce21e5289671474bfce2968cf91168521423677618c52590e047e9f69b802",
"md5": "39ddab015ea37123a2026bbf7dfe85a8",
"sha256": "ac71a76a89d29f0bddeb265be8e729a1d4ebe85afd1d70e7d05f12ec18588920"
},
"downloads": -1,
"filename": "PyFiberModes-0.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "39ddab015ea37123a2026bbf7dfe85a8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 33868,
"upload_time": "2024-02-08T05:46:08",
"upload_time_iso_8601": "2024-02-08T05:46:08.974287Z",
"url": "https://files.pythonhosted.org/packages/7f/5c/e21e5289671474bfce2968cf91168521423677618c52590e047e9f69b802/PyFiberModes-0.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-08 05:46:08",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "MartinPdeS",
"github_project": "PyFiberModes",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pyfibermodes"
}
JSON
