Installation

Step 1: Project Environment Setup (Optional)

Setting up a local Python environment for each project is good practice as it helps manage dependencies and versions more effectively. We recommend using Conda or Python virtual environments. Alternatively, you can install the requirements in your own Python environment and skip this step.

Conda Guide

If you do not have Conda installed, follow the official Conda documentation to download and install Conda.

Once Conda is installed, create an environment for the rivet project:

conda create -y --name rivet python=3.10
conda activate rivet

Virtualenv Guide

If you do not have Virtualenv installed, follow the virtualenv documentation to download and install the latest version.

Once Virtualenv is installed, create an environment for the rivet project:

virtualenv venv --python=python3.10
source venv/bin/activate

Step 2: Install Rivet package

To install Rivet Transpiler base version(support only qiskit transpilation stack) run:

pip install 'rivet-transpiler @ git+https://github.com/haiqu-ai/rivet.git'

To install with all stacks please run:

pip install 'rivet-transpiler[stacks] @ git+https://github.com/haiqu-ai/rivet.git'

To install only BQSKit or only Pytket support:

pip install 'rivet-transpiler[bqskit] @ git+https://github.com/haiqu-ai/rivet.git'
pip install 'rivet-transpiler[pytket] @ git+https://github.com/haiqu-ai/rivet.git'

Step 3: Running examples (Optional)

To run Rivet Transpiler example notebooks, first clone the full repository and navigate to the rivet folder:

git clone https://github.com/haiqu-ai/rivet.git
cd rivet

Install additional packages needed for examples:

pip install 'rivet-transpiler[examples] @ git+https://github.com/haiqu-ai/rivet.git'

Run Jupyter and open examples notebooks

jupyter notebook