braidpy 0.1.0

Python library for working with braids

BraidPy

A Python library for working with braids.

Features

• Representation of braids
• Braid operations and manipulations
• Visualization capabilities
• Mathematical properties and computations
• [] unreduced Burau matrix representation
• [] reduced Burau matrix representation
• [] Alexaner polynomial

Usage

from braidpy import Braid

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

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

🛠️ Installation

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

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

To install the required dependencies, follow the steps below:

1. Install uv by following the official installation guide.
2. Alternatively, run the command from root of repository:

   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 is available at: https://braidpy.readthedocs.io/en/latest/

Project Team:

Human:

• Baptiste Labat

Bot: chatgpt windsurf

🤝 Contributions

Contributions are welcome! Please open an issue or submit a pull request 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