| Name | FiberFusing JSON |
| Version |
1.6.0.1
JSON |
| download |
| home_page | None |
| Summary | A package fiber fusing configuration simulating the transverse fusion of fiber optics. |
| upload_time | 2024-12-10 14:38:19 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| 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 |
fiber
fusing
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
FiberFusing
===========
|logo|
.. list-table::
:widths: 10 25 25 25
:header-rows: 0
* - Meta
- |python|
- |docs|
- |colab|
* - Testing
- |ci/cd|
- |coverage|
-
* - PyPi
- |PyPi|
- |PyPi_download|
-
* - Anaconda
- |anaconda|
- |anaconda_download|
-
FiberFusing is a Python package designed for simulating the fiber fusing process. With this tool, users can define an initial fiber configuration and simulate the fusion process as a function of the fusion degree parameter. The package currently supports seven predefined structures:
1x1, 2x2, 3x3, 4x4, 6x6, 7x7, and 19x19 configurations.
As follows, an example of 3x3 fused fiber.
|example_3x3|
----
Documentation
**************
For the most up-to-date documentation, visit the official `FiberFusing Docs <https://fiberfusing.readthedocs.io/en/latest/>`_ or click the badge below:
|docs|
----
Installation
************
Getting started with FiberFusing is easy. Simply install via `pip`:
.. code-block:: bash
pip install FiberFusing
|PyPi|
----
Testing
*******
To run tests locally after cloning the GitHub repository, you’ll need to install the dependencies and run the following commands:
.. code-block:: bash
git clone https://github.com/MartinPdeS/FiberFusing.git
cd FiberFusing
pip install FiberFusing[testing]
pytest
For more detailed testing instructions, consult the documentation.
----
Coding examples
***************
Explore a wide range of examples demonstrating the usage of FiberFusing in the `Examples section <https://martinpdes.github.io/FiberFusing/gallery/index.html>`_ of the documentation.
----
Contributing & Contact
***********************
FiberFusing is an open project and collaboration is encouraged! If you're interested in contributing or have any questions, feel free to reach out.
**Author:** `Martin Poinsinet de Sivry-Houle <https://github.com/MartinPdeS>`_
**Email:** `martin.poinsinet-de-sivry@polymtl.ca <mailto:martin.poinsinet-de-sivry@polymtl.ca?subject=FiberFusing>`_
We welcome feedback and contributions to improve FiberFusing and expand its capabilities.
----
.. |python| image:: https://img.shields.io/pypi/pyversions/fiberfusing.svg
:target: https://www.python.org/
:alt: Python version
.. |PyPi| image:: https://badge.fury.io/py/FiberFusing.svg
:target: https://pypi.org/project/FiberFusing/
:alt: PyPi
.. |PyPi_download| image:: https://img.shields.io/pypi/dm/fiberfusing.svg
:target: https://pypistats.org/packages/fiberfusing
:alt: PyPi download statistics
.. |logo| image:: https://github.com/MartinPdeS/FiberFusing/raw/master/docs/images/logo.png
:alt: FiberFusing's logo
.. |docs| image:: https://github.com/martinpdes/fiberfusing/actions/workflows/deploy_documentation.yml/badge.svg
:target: https://martinpdes.github.io/FiberFusing/
:alt: Documentation Status
.. |coverage| image:: https://raw.githubusercontent.com/MartinPdeS/FiberFusing/python-coverage-comment-action-data/badge.svg
:target: https://htmlpreview.github.io/?https://github.com/MartinPdeS/FiberFusing/blob/python-coverage-comment-action-data/htmlcov/index.html
:alt: Unittest coverage
.. |ci/cd| image:: https://github.com/martinpdes/fiberfusing/actions/workflows/deploy_coverage.yml/badge.svg
:target: https://martinpdes.github.io/FiberFusing/actions
:alt: Unittest Status
.. |anaconda_download| image:: https://anaconda.org/martinpdes/fiberfusing/badges/downloads.svg
:alt: Anaconda downloads
:target: https://anaconda.org/martinpdes/fiberfusing
.. |anaconda| image:: https://anaconda.org/martinpdes/fiberfusing/badges/version.svg
:alt: Anaconda version
:target: https://anaconda.org/martinpdes/fiberfusing
.. |example_3x3| image:: https://github.com/MartinPdeS/FiberFusing/raw/master/docs/images/example_3x3.png
:alt: Example for 3 fiber structure
.. |colab| image:: https://colab.research.google.com/assets/colab-badge.svg
:target: https://colab.research.google.com/github/MartinPdeS/FiberFusing/blob/master/notebook.ipynb
Raw data
{
"_id": null,
"home_page": null,
"name": "FiberFusing",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "fiber, fusing",
"author": null,
"author_email": "Martin Poinsinet de Sivry-Houle <martin.poinsinet.de.sivry@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/d8/c6/ac766e6829ec77f1ba7563f3e3f041e326dfe41eda8510328f09841c6307/fiberfusing-1.6.0.1.tar.gz",
"platform": null,
"description": "FiberFusing\n===========\n\n|logo|\n\n\n.. list-table::\n :widths: 10 25 25 25\n :header-rows: 0\n\n * - Meta\n - |python|\n - |docs|\n - |colab|\n * - Testing\n - |ci/cd|\n - |coverage|\n -\n * - PyPi\n - |PyPi|\n - |PyPi_download|\n -\n * - Anaconda\n - |anaconda|\n - |anaconda_download|\n -\n\n\nFiberFusing is a Python package designed for simulating the fiber fusing process. With this tool, users can define an initial fiber configuration and simulate the fusion process as a function of the fusion degree parameter. The package currently supports seven predefined structures:\n\n1x1, 2x2, 3x3, 4x4, 6x6, 7x7, and 19x19 configurations.\n\nAs follows, an example of 3x3 fused fiber.\n|example_3x3|\n\n\n----\n\nDocumentation\n**************\nFor the most up-to-date documentation, visit the official `FiberFusing Docs <https://fiberfusing.readthedocs.io/en/latest/>`_ or click the badge below:\n\n|docs|\n\n----\n\nInstallation\n************\nGetting started with FiberFusing is easy. Simply install via `pip`:\n\n.. code-block:: bash\n\n pip install FiberFusing\n\n|PyPi|\n\n----\n\nTesting\n*******\nTo run tests locally after cloning the GitHub repository, you\u2019ll need to install the dependencies and run the following commands:\n\n.. code-block:: bash\n\n git clone https://github.com/MartinPdeS/FiberFusing.git\n cd FiberFusing\n pip install FiberFusing[testing]\n pytest\n\nFor more detailed testing instructions, consult the documentation.\n\n----\n\nCoding examples\n***************\nExplore a wide range of examples demonstrating the usage of FiberFusing in the `Examples section <https://martinpdes.github.io/FiberFusing/gallery/index.html>`_ of the documentation.\n\n----\n\nContributing & Contact\n***********************\nFiberFusing is an open project and collaboration is encouraged! If you're interested in contributing or have any questions, feel free to reach out.\n\n**Author:** `Martin Poinsinet de Sivry-Houle <https://github.com/MartinPdeS>`_\n**Email:** `martin.poinsinet-de-sivry@polymtl.ca <mailto:martin.poinsinet-de-sivry@polymtl.ca?subject=FiberFusing>`_\n\nWe welcome feedback and contributions to improve FiberFusing and expand its capabilities.\n\n----\n\n.. |python| image:: https://img.shields.io/pypi/pyversions/fiberfusing.svg\n :target: https://www.python.org/\n :alt: Python version\n\n.. |PyPi| image:: https://badge.fury.io/py/FiberFusing.svg\n :target: https://pypi.org/project/FiberFusing/\n :alt: PyPi\n\n.. |PyPi_download| image:: https://img.shields.io/pypi/dm/fiberfusing.svg\n :target: https://pypistats.org/packages/fiberfusing\n :alt: PyPi download statistics\n\n.. |logo| image:: https://github.com/MartinPdeS/FiberFusing/raw/master/docs/images/logo.png\n :alt: FiberFusing's logo\n\n.. |docs| image:: https://github.com/martinpdes/fiberfusing/actions/workflows/deploy_documentation.yml/badge.svg\n :target: https://martinpdes.github.io/FiberFusing/\n :alt: Documentation Status\n\n.. |coverage| image:: https://raw.githubusercontent.com/MartinPdeS/FiberFusing/python-coverage-comment-action-data/badge.svg\n :target: https://htmlpreview.github.io/?https://github.com/MartinPdeS/FiberFusing/blob/python-coverage-comment-action-data/htmlcov/index.html\n :alt: Unittest coverage\n\n.. |ci/cd| image:: https://github.com/martinpdes/fiberfusing/actions/workflows/deploy_coverage.yml/badge.svg\n :target: https://martinpdes.github.io/FiberFusing/actions\n :alt: Unittest Status\n\n.. |anaconda_download| image:: https://anaconda.org/martinpdes/fiberfusing/badges/downloads.svg\n :alt: Anaconda downloads\n :target: https://anaconda.org/martinpdes/fiberfusing\n\n.. |anaconda| image:: https://anaconda.org/martinpdes/fiberfusing/badges/version.svg\n :alt: Anaconda version\n :target: https://anaconda.org/martinpdes/fiberfusing\n\n.. |example_3x3| image:: https://github.com/MartinPdeS/FiberFusing/raw/master/docs/images/example_3x3.png\n :alt: Example for 3 fiber structure\n\n.. |colab| image:: https://colab.research.google.com/assets/colab-badge.svg\n :target: https://colab.research.google.com/github/MartinPdeS/FiberFusing/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 fiber fusing configuration simulating the transverse fusion of fiber optics.",
"version": "1.6.0.1",
"project_urls": {
"Documentation": "https://martinpdes.github.io/FiberFusing/",
"Homepage": "https://github.com/MartinPdeS/FiberFusing",
"Repository": "https://github.com/MartinPdeS/FiberFusing.git"
},
"split_keywords": [
"fiber",
" fusing"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "16414958cb43b5f1c2f02f118eae8a897e8044049e118adf67ccf865f27ae1f6",
"md5": "1c4ec1b52d3502e56d88e803e1f036a7",
"sha256": "a7041811f23806d121d776f5d52b30105ec6522db767538fe645295cefc6883e"
},
"downloads": -1,
"filename": "FiberFusing-1.6.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1c4ec1b52d3502e56d88e803e1f036a7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 61774,
"upload_time": "2024-12-10T14:38:17",
"upload_time_iso_8601": "2024-12-10T14:38:17.071615Z",
"url": "https://files.pythonhosted.org/packages/16/41/4958cb43b5f1c2f02f118eae8a897e8044049e118adf67ccf865f27ae1f6/FiberFusing-1.6.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d8c6ac766e6829ec77f1ba7563f3e3f041e326dfe41eda8510328f09841c6307",
"md5": "69e0e90f162369be4aece4b25f3b1e25",
"sha256": "f5e8109ee442451c9900d6bfbca7a9f79a5cbf0a6148056722e485e68579b837"
},
"downloads": -1,
"filename": "fiberfusing-1.6.0.1.tar.gz",
"has_sig": false,
"md5_digest": "69e0e90f162369be4aece4b25f3b1e25",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 458588,
"upload_time": "2024-12-10T14:38:19",
"upload_time_iso_8601": "2024-12-10T14:38:19.736992Z",
"url": "https://files.pythonhosted.org/packages/d8/c6/ac766e6829ec77f1ba7563f3e3f041e326dfe41eda8510328f09841c6307/fiberfusing-1.6.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-10 14:38:19",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "MartinPdeS",
"github_project": "FiberFusing",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "fiberfusing"
}
