| Name | SuPyMode JSON |
| Version |
2.0.3.3
JSON |
| download |
| home_page | None |
| Summary | A package for light propagation in fiber optics. |
| upload_time | 2024-12-12 11:08:03 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.11 |
| license | MIT License Copyright (c) 2020 Martin de Sivry Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
coupled-mode theory
waveguide
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
SuPyMode
========
|python|
|docs|
|Citation|
|coverage|
|PyPi|
|PyPi_download|
|colab|
.. figure:: https://github.com/MartinPdeS/SuPyMode/blob/master/docs/images/mode_propagation.gif?raw=true
:alt: some image
:class: with-shadow float-left
:width: 800px
Propagation of mode in an adiabatic 2x1 modally-specific photonic lantern.
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 <https://supymode.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 SuPyMode
Manual installation
*******************
To install manually (os independent) you will need to install:
1. cmake (3.16+)
Then, download and install the SuPyMode package:
.. code-block:: python
>>> git clone --recurse-submodules https://github.com/MartinPdeS/SuPyMode.git
>>> cd SuPyMode && mkdir build && cd build
>>> cmake ..
>>> cmake --build .
>>> cd ..
>>> pip3 install .
----
Testing
*******
Make sure to install both coverage and pytest using ``pip3 install coverage pytest``. To test locally (with cloning the GitHub repository) you'll need to install the dependencies and run the coverage command as
.. code:: python
>>> git clone --recurse-submodules https://github.com/MartinPdeS/SuPyMode.git
>>> cd SuPyMode
>>> pip3 install PyFiberModes
>>> 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 <https://github.com/MartinPdS>`_ .
Email:`martin.poinsinet-de-sivry@polymtl.ca <mailto:martin.poinsinet-de-sivry@polymtl.ca?subject=SuPyMode>`_ .
.. |python| image:: https://img.shields.io/badge/Made%20with-Python-1f425f.svg
:target: https://www.python.org/
.. |docs| image:: https://github.com/martinpdes/supymode/actions/workflows/deploy_documentation.yml/badge.svg
:target: https://martinpdes.github.io/SuPyMode/
:alt: Documentation Status
.. |Citation| image:: https://zenodo.org/badge/366930899.svg
:target: https://zenodo.org/badge/latestdoi/366930899
.. |coverage| image:: https://raw.githubusercontent.com/MartinPdeS/SuPyMode/python-coverage-comment-action-data/badge.svg
:alt: Unittest coverage
:target: https://htmlpreview.github.io/?https://github.com/MartinPdeS/SuPyMode/blob/python-coverage-comment-action-data/htmlcov/index.html
.. |PyPi| image:: https://badge.fury.io/py/SuPyMode.svg
:target: https://pypi.org/project/SuPyMode/
.. |PyPi_download| image:: https://img.shields.io/pypi/dm/supymode.svg
:target: https://pypistats.org/packages/supymode
.. |colab| image:: https://colab.research.google.com/assets/colab-badge.svg
:target: https://colab.research.google.com/github/MartinPdeS/SuPyMode/blob/master/notebook.ipynb
Raw data
{
"_id": null,
"home_page": null,
"name": "SuPyMode",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": null,
"keywords": "coupled-mode theory, waveguide",
"author": null,
"author_email": "Martin Poinsinet de Sivry-Houle <martin.poinsinet.de.sivry@gmail.com>",
"download_url": null,
"platform": null,
"description": "SuPyMode\n========\n\n|python|\n|docs|\n|Citation|\n|coverage|\n|PyPi|\n|PyPi_download|\n|colab|\n\n\n.. figure:: https://github.com/MartinPdeS/SuPyMode/blob/master/docs/images/mode_propagation.gif?raw=true\n :alt: some image\n :class: with-shadow float-left\n :width: 800px\n\n Propagation of mode in an adiabatic 2x1 modally-specific photonic lantern.\n\n\n\n\nThis project aims to develop an useful tool design and optimize fiber optic tapered component.\nSuPyMode is a Python library linked to a c++ core allowing for a flexible interface and fast computing core.\nThe library also aims to offer the end-user a great vizual tools for data analysis.\nTo 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.\n\n----\n\nDocumentation\n**************\nAll the latest available documentation is available `here <https://supymode.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 SuPyMode\n\n\n\nManual installation\n*******************\n\nTo install manually (os independent) you will need to install:\n\n1. cmake (3.16+)\n\nThen, download and install the SuPyMode package:\n\n.. code-block:: python\n\n >>> git clone --recurse-submodules https://github.com/MartinPdeS/SuPyMode.git\n >>> cd SuPyMode && mkdir build && cd build\n >>> cmake ..\n >>> cmake --build .\n >>> cd ..\n >>> pip3 install .\n\n----\n\nTesting\n*******\n\nMake sure to install both coverage and pytest using ``pip3 install coverage pytest``. To test locally (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 --recurse-submodules https://github.com/MartinPdeS/SuPyMode.git\n >>> cd SuPyMode\n >>> pip3 install PyFiberModes\n >>> coverage run --source=SuPyMode --module pytest --verbose tests\n >>> coverage report --show-missing\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\nSuPyMode 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=SuPyMode>`_ .\n\n\n.. |python| image:: https://img.shields.io/badge/Made%20with-Python-1f425f.svg\n :target: https://www.python.org/\n\n.. |docs| image:: https://github.com/martinpdes/supymode/actions/workflows/deploy_documentation.yml/badge.svg\n :target: https://martinpdes.github.io/SuPyMode/\n :alt: Documentation Status\n\n.. |Citation| image:: https://zenodo.org/badge/366930899.svg\n :target: https://zenodo.org/badge/latestdoi/366930899\n\n.. |coverage| image:: https://raw.githubusercontent.com/MartinPdeS/SuPyMode/python-coverage-comment-action-data/badge.svg\n :alt: Unittest coverage\n :target: https://htmlpreview.github.io/?https://github.com/MartinPdeS/SuPyMode/blob/python-coverage-comment-action-data/htmlcov/index.html\n\n.. |PyPi| image:: https://badge.fury.io/py/SuPyMode.svg\n :target: https://pypi.org/project/SuPyMode/\n\n.. |PyPi_download| image:: https://img.shields.io/pypi/dm/supymode.svg\n :target: https://pypistats.org/packages/supymode\n\n.. |colab| image:: https://colab.research.google.com/assets/colab-badge.svg\n :target: https://colab.research.google.com/github/MartinPdeS/SuPyMode/blob/master/notebook.ipynb\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2020 Martin de Sivry Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
"summary": "A package for light propagation in fiber optics.",
"version": "2.0.3.3",
"project_urls": null,
"split_keywords": [
"coupled-mode theory",
" waveguide"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4a8f9ca2ebf76f433920615b25a52337349b9dbe783c2349f68fcb545431bf00",
"md5": "fc604f78a6a9a19aa1f89e927aa5e904",
"sha256": "b54a2790cf6650a375acbfa8a629251e86c60283f15d5ec4304430151798340a"
},
"downloads": -1,
"filename": "supymode-2.0.3.3-cp311-cp311-macosx_14_0_arm64.whl",
"has_sig": false,
"md5_digest": "fc604f78a6a9a19aa1f89e927aa5e904",
"packagetype": "bdist_wheel",
"python_version": "cp311",
"requires_python": ">=3.11",
"size": 1575072,
"upload_time": "2024-12-12T11:08:03",
"upload_time_iso_8601": "2024-12-12T11:08:03.734299Z",
"url": "https://files.pythonhosted.org/packages/4a/8f/9ca2ebf76f433920615b25a52337349b9dbe783c2349f68fcb545431bf00/supymode-2.0.3.3-cp311-cp311-macosx_14_0_arm64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "66f321cab1fa3e5847b29fa1ee3019f3da0ac5855220919ac232952f4cfabbfb",
"md5": "88cca438a8de4987e57ee2e45193f481",
"sha256": "db36ca8c3a2c56ab03a4f9b55d8876603393b1d4ad8e93749a7e493bf1547787"
},
"downloads": -1,
"filename": "supymode-2.0.3.3-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"has_sig": false,
"md5_digest": "88cca438a8de4987e57ee2e45193f481",
"packagetype": "bdist_wheel",
"python_version": "cp311",
"requires_python": ">=3.11",
"size": 675560,
"upload_time": "2024-12-12T11:08:07",
"upload_time_iso_8601": "2024-12-12T11:08:07.000567Z",
"url": "https://files.pythonhosted.org/packages/66/f3/21cab1fa3e5847b29fa1ee3019f3da0ac5855220919ac232952f4cfabbfb/supymode-2.0.3.3-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4b190cb10a39084e08da1bc7f94fa25c6f7ad0891a9b41f290fece9bb6a8351e",
"md5": "b0b31665f52784721612f9e9158528b9",
"sha256": "c26666937245b8389ebad45be0bd8fb4cf0706b994fdafc8cb476cf43d206b39"
},
"downloads": -1,
"filename": "supymode-2.0.3.3-cp311-cp311-win_amd64.whl",
"has_sig": false,
"md5_digest": "b0b31665f52784721612f9e9158528b9",
"packagetype": "bdist_wheel",
"python_version": "cp311",
"requires_python": ">=3.11",
"size": 1151174,
"upload_time": "2024-12-12T11:08:14",
"upload_time_iso_8601": "2024-12-12T11:08:14.768274Z",
"url": "https://files.pythonhosted.org/packages/4b/19/0cb10a39084e08da1bc7f94fa25c6f7ad0891a9b41f290fece9bb6a8351e/supymode-2.0.3.3-cp311-cp311-win_amd64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "df45d80f505078681027a16e1744c34dfb8ae7e287a97757a39a517b81c7c965",
"md5": "82535ad2c61abf28429b4cae4c9b6dfa",
"sha256": "442170062d8ceecf25fb1fbe152116548eb75dd68f667be8f877908e0fe7a342"
},
"downloads": -1,
"filename": "supymode-2.0.3.3-cp312-cp312-macosx_14_0_arm64.whl",
"has_sig": false,
"md5_digest": "82535ad2c61abf28429b4cae4c9b6dfa",
"packagetype": "bdist_wheel",
"python_version": "cp312",
"requires_python": ">=3.11",
"size": 2070465,
"upload_time": "2024-12-12T11:08:05",
"upload_time_iso_8601": "2024-12-12T11:08:05.541610Z",
"url": "https://files.pythonhosted.org/packages/df/45/d80f505078681027a16e1744c34dfb8ae7e287a97757a39a517b81c7c965/supymode-2.0.3.3-cp312-cp312-macosx_14_0_arm64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e36424607b481b4ceda186dcbeaacbd46c5efffc1ab6ca3f3adf687727378fc1",
"md5": "890d306133a36e864680bd2e22188155",
"sha256": "866b8f039412b16d505eb86b38599562ea3b7f2d40bbb4c91cbca7caecb61f1d"
},
"downloads": -1,
"filename": "supymode-2.0.3.3-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"has_sig": false,
"md5_digest": "890d306133a36e864680bd2e22188155",
"packagetype": "bdist_wheel",
"python_version": "cp312",
"requires_python": ">=3.11",
"size": 1257927,
"upload_time": "2024-12-12T11:08:10",
"upload_time_iso_8601": "2024-12-12T11:08:10.137630Z",
"url": "https://files.pythonhosted.org/packages/e3/64/24607b481b4ceda186dcbeaacbd46c5efffc1ab6ca3f3adf687727378fc1/supymode-2.0.3.3-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "15054cfb745c90b56af476c55d97e16d3ef706792bcef413a17e32fe37a22674",
"md5": "0263a3d6ef0425b2ccafd51c634a1dd0",
"sha256": "e355b25c8fb5b8c8594aa7beb20d7659395b439e2cdaf2d242b78b31fc98130f"
},
"downloads": -1,
"filename": "supymode-2.0.3.3-cp312-cp312-win_amd64.whl",
"has_sig": false,
"md5_digest": "0263a3d6ef0425b2ccafd51c634a1dd0",
"packagetype": "bdist_wheel",
"python_version": "cp312",
"requires_python": ">=3.11",
"size": 2213866,
"upload_time": "2024-12-12T11:08:16",
"upload_time_iso_8601": "2024-12-12T11:08:16.141169Z",
"url": "https://files.pythonhosted.org/packages/15/05/4cfb745c90b56af476c55d97e16d3ef706792bcef413a17e32fe37a22674/supymode-2.0.3.3-cp312-cp312-win_amd64.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-12 11:08:03",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "supymode"
}
