Date: Mar 23, 2025, Version: 1.6.0.1

FiberFusing#

FiberFusing's logo

Meta

Python version

Documentation Status

colab

Testing

Unittest Status

Unittest coverage

PyPi

PyPi

PyPi download statistics

Anaconda

Anaconda version

Anaconda downloads

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 for 3 fiber structure

Documentation#

For the most up-to-date documentation, visit the official FiberFusing Docs or click the badge below:

Documentation Status

Installation#

Getting started with FiberFusing is easy. Simply install via pip:

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:

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 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 Email: martin.poinsinet-de-sivry@polymtl.ca

We welcome feedback and contributions to improve FiberFusing and expand its capabilities.