|Logo|
|python|
|PyPi|
|PyPi_download|
|docs|
|Unittest|
FiberFusing
===========
Python package for fiber fusing simulations. This package allow the user to defined an initial fibre configuration and simulate the fusion process as a funciton of the fusion degree parameter. At the moment a total of seven pre-defined structure are present: 1x1, 2x2, 3x3, 4x4, 6x6, 7x7, 19x19.
----
Documentation
**************
All the latest available documentation is available `here <https://fiberfusing.readthedocs.io/en/latest/>`_ or you can click the following badge:
|docs|
----
Installation
************
As simple as it gets using pip
.. code-block:: python
>>> pip install FiberFusing
|PyPi|
----
Testing
*******
To test localy (with cloning the GitHub repository) you'll need to install the dependencies and run the coverage command as
.. code:: console
>>> git clone https://github.com/MartinPdeS/FiberFusing.git
>>> cd FiberFusing
>>> pip install -r requirements/requirements.txt
>>> coverage run --source=FiberFusing --module pytest --verbose tests
>>> coverage report --show-missing
----
Coding examples
***************
Plenty of examples are available online, I invite you to check the `examples <https://fiberfusing.readthedocs.io/en/latest/Examples.html>`_
section of the documentation.
----
Contact Information
*******************
As of 2021 the project is still under development if you want to collaborate it would be a pleasure. I encourage you to contact me.
FiberFusing 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=FiberFusing>`_ .
.. |Unittest| image:: https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/MartinPdeS/49dc3e2c41180ac9018ae803a8acd177/raw
.. |python| image:: https://img.shields.io/pypi/pyversions/fiberfusing.svg
:target: https://www.python.org/
.. |PyPi| image:: https://badge.fury.io/py/FiberFusing.svg
:target: https://pypi.org/project/FiberFusing/
.. |PyPi_download| image:: https://img.shields.io/pypi/dm/fiberfusing.svg
:target: https://pypistats.org/packages/fiberfusing
.. |Logo| image:: https://github.com/MartinPdeS/FiberFusing/raw/master/docs/images/logo.png
.. |docs| image:: https://readthedocs.org/projects/fiberfusing/badge/?version=latest
:target: https://fiberfusing.readthedocs.io/en/latest/?badge=latest
Raw data
{
"_id": null,
"home_page": "https://github.com/MartinPdeS/FiberFusing",
"name": "FiberFusing",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "Martin Poinsinet de Sivry",
"author_email": "Martin.poinsinet.de.sivry@gmail.com",
"download_url": null,
"platform": "unix",
"description": "|Logo|\n\n\n|python|\n|PyPi|\n|PyPi_download|\n|docs|\n|Unittest|\n\nFiberFusing\n===========\nPython package for fiber fusing simulations. This package allow the user to defined an initial fibre configuration and simulate the fusion process as a funciton of the fusion degree parameter. At the moment a total of seven pre-defined structure are present: 1x1, 2x2, 3x3, 4x4, 6x6, 7x7, 19x19.\n\n\n----\n\nDocumentation\n**************\nAll the latest available documentation is available `here <https://fiberfusing.readthedocs.io/en/latest/>`_ or you can click the following badge:\n\n|docs|\n\n\n\n\n\n----\n\nInstallation\n************\nAs simple as it gets using pip\n\n.. code-block:: python\n\n >>> pip install FiberFusing\n\n|PyPi|\n\n\n\n\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:: console\n\n >>> git clone https://github.com/MartinPdeS/FiberFusing.git\n >>> cd FiberFusing\n >>> pip install -r requirements/requirements.txt\n >>> coverage run --source=FiberFusing --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://fiberfusing.readthedocs.io/en/latest/Examples.html>`_\nsection of the documentation.\n\n\n\n\n\n----\n\nContact Information\n*******************\nAs of 2021 the project is still under development if you want to collaborate it would be a pleasure. I encourage you to contact me.\n\nFiberFusing 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=FiberFusing>`_ .\n\n\n.. |Unittest| image:: https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/MartinPdeS/49dc3e2c41180ac9018ae803a8acd177/raw\n\n.. |python| image:: https://img.shields.io/pypi/pyversions/fiberfusing.svg\n :target: https://www.python.org/\n\n.. |PyPi| image:: https://badge.fury.io/py/FiberFusing.svg\n :target: https://pypi.org/project/FiberFusing/\n\n.. |PyPi_download| image:: https://img.shields.io/pypi/dm/fiberfusing.svg\n :target: https://pypistats.org/packages/fiberfusing\n\n.. |Logo| image:: https://github.com/MartinPdeS/FiberFusing/raw/master/docs/images/logo.png\n\n.. |docs| image:: https://readthedocs.org/projects/fiberfusing/badge/?version=latest\n :target: https://fiberfusing.readthedocs.io/en/latest/?badge=latest\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A package fiber fusing simulation.",
"version": "1.2.1",
"project_urls": {
"Homepage": "https://github.com/MartinPdeS/FiberFusing"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "fc52df2af992f074e87d30d645f6208be2e4c73aee2fb543d7e0315a7fb3f0d0",
"md5": "061aec4b3687cf4df8302f387cdb9617",
"sha256": "53b5a69df1f6dea29da223085da6c27e5761f5c6ad2d4f9825f3c4ab2aff8bd9"
},
"downloads": -1,
"filename": "FiberFusing-1.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "061aec4b3687cf4df8302f387cdb9617",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 154122,
"upload_time": "2024-05-28T21:33:26",
"upload_time_iso_8601": "2024-05-28T21:33:26.256263Z",
"url": "https://files.pythonhosted.org/packages/fc/52/df2af992f074e87d30d645f6208be2e4c73aee2fb543d7e0315a7fb3f0d0/FiberFusing-1.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-28 21:33:26",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "MartinPdeS",
"github_project": "FiberFusing",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "fiberfusing"
}
JSON
