Installation

circle_bundles requires Python 3.9 or newer.

Basic installation

Install the package directly from GitHub using pip:

pip install git+https://github.com/bradturow/Circle_Bundles.git

Then import the package in Python as:

import circle_bundles as cb

The core package installs everything needed for the main pipeline. For interactive visualization support, install the viz extra:

pip install "circle_bundles[viz] @ git+https://github.com/bradturow/Circle_Bundles.git"

This adds Plotly for interactive 3D plots.

Some tutorials also use the following packages, which can be installed separately:

pip install ripser persim dreimac

To contribute or run the test suite, clone the repository and install in editable mode with development dependencies:

git clone https://github.com/bradturow/Circle_Bundles.git
cd Circle_Bundles
pip install -e ".[dev]"

This installs pytest and ruff for testing and linting. Run the test suite with:

pytest

You can verify that circle_bundles is installed correctly by running:

import circle_bundles as cb
print(cb.__version__)