braidpy 0.2.0

Python library for working with braids

BraidPy

A Python library for working with braids, with the goal to help design real world complex 3D braids, using recent advances in braid theory. Source is available at on github

Features

• Mathematical representation of braids with braid words using Artin's generators
• Conversion between different braid word formats
• Braid operations and manipulations (inversion, handles reduction, ...)
• Generation of parametric braid from braid word
• Visualization capabilities (ASCI, 2D and 3D)
• Computations of mathematical properties of braid word or invariants of braid
• Annulus braids
• Conversion from parametric braid to braid word
• Conversion from material braid to parametric braid
• Simulation of machine braiding process (hexagonal braiding machine)

Basic example

from braidpy import Braid

# Create a braid
b = Braid([1, 2, -1])

# Perform operations
result = b * b.inverse()

🛠️ Installation

Release versions are available on Pypi and it should be very easy to install braidpy in your python environment.

Using pip

pip install braidpy

Or using poetry

poetry add braidpy

Or using uv (recommended package manager used on the project)

uv add braidpy

🛠️ Installation from source

The version in pypi might lack features or bug corrections compared to the development versions.

You can download the code directly from GitHub or using git:

git clone [e-mail]:baptistelabat/braidpy.git

By default, you should be on the 'develop' branch.

To install the required dependencies, follow the steps below:

2. On linux, run the commands from root of repository to install uv. Use the official installation guide otherwise.

   sudo apt-get install build-essential
   cd braidpy
   make install-uv
   

---

Test

To launch the complete suite of tests, launch the following command:

uv run pytest tests

Alternatively, if you have make install, just run:

make test

---

📜 Documentation

Documentation of released versions is hosted by [readthedocs] (https://braidpy.readthedocs.io/en/latest/)

Documentation of development version can be found on [github pages] (https://baptistelabat.github.io/braidpy) You should be able to select among several versions. Note that this process is manual. You can also generate the documentation for your version installed from sources

make docs

Project Team:

This is a single person project for now, but I would be happy to make the team grow. Human:

• Baptiste Labat

Bot: chatgpt windsurf

🤝 Contributions

Contributions are welcome! Please open an issue or submit a pull request from your fork to suggest changes, report bugs, or propose new features.

Here are a few code guidelines:

• We use english for code and comments.
• We use Google style docstring.
• We use type hinting.
  Please be sure to install the pre-commit tool in order to check your code while commiting in order to keep a clean project history.

pre-commit install

Please have a look to makefile to find helpful commands.

📜 License

This project is licensed under the Mozilla Public License 2.0 - see the LICENSE file for details.

---

🖇️ References

https://dehornoy.lmno.cnrs.fr