Getting Started¶

This package can be installed from PyPI with

pip install hybridlane[extras]

The available extra flags are:

all: Installs all extra flags.
bq: Adds support for the bosonicqiskit.hybrid device.

Developing¶

To get started developing this package, first install the uv python package manager. Next, clone the package from Github and create the virtual environment

git clone https://www.github.com/pnnl/hybridlane
cd hybridlane
uv sync --all-extras

This should take care of installing all the developer dependencies for you and build the package.

Documentation¶

The documentation is automatically produced by Sphinx using comments in the code. To build the documentation, run

cd docs
uv run make html

To enable hot-reloading (live updating) of the documentation, run

cd docs
uv run sphinx-autobuild source _build/html --watch ../src --ignore "source/_autoapi/**/*.rst" --re-ignore ".*__pycache__.*"

and open your browser to http://localhost:8000. For users unfamiliar with the Sphinx reStructured Text format, there is a nice cheatsheet here.

Testing¶

Tests can be run by pytest, optionally producing a coverage report

uv run pytest [--cov=hybridlane [--cov-report=html]]