No project description provided
Project description
Native code for BQSKit
bqskitrs
is a Python package that implements circuit instantiation and simulation to accelerate BQSKit.
Installing bqskitrs
You can often install bqskitrs
via PyPi with pip
:
pip install bqskitrs
this will use pre-built wheels. Sometimes wheels are not available, so you must build from source.
Building bqskitrs
Linux
It's best to build and install the manylinux version with the provided docker container:
git clone https://github.com/BQSKit/bqskitrs.git --recursive
cd bqskitrs
docker run -e OPENBLAS_ARGS="DYNAMIC_ARCH=1" --rm -v $(pwd):/io edyounis/bqskitrs-manylinux:1.1 build --release --features=openblas --compatibility=manylinux2014
pip install --no-index --find-links=target/wheels bqskitrs
MacOS
Make sure the version of pip you have is at least 20.0.2.
You can check via pip -V
and upgrade via python3 -m pip install -U pip
.
First, install the dependencies. We use homebrew here, which is what we build the official package against.
brew install gcc ceres-solver eigen lapack
Once that is complete you should then install Rust like as follows:
curl https://sh.rustup.rs -sSf | sh -s -- -y
Then clone and enter enter the bqskitrs
directory:
git clone https://github.com/BQSKit/bqskitrs.git --recursive
cd bqskitrs
Then build the wheel (package file) with maturin:
pip install -U setuptools wheel maturin
maturin build --features="accelerate" --release
If you encounter issues on an intel x86 Mac computer with a message like "rust failed to run custom build command for cxx', you may need to run the following build command instead:
MACOSX_DEPLOYMENT_TARGET=11.0 maturin build --features="accelerate"
Finally install the wheel that you built:
pip install --no-index --find-links=target/wheels bqskitrs
Once it is done installing the wheel, verify that the installation succeeded by running
python3 -c 'import bqskitrs'
It should not print anything out nor give any error.
Windows
Make sure the version of pip you have is at least 20.0.2.
You can check via pip -V
and upgrade via python3 -m pip install -U pip
.
Download and install rust via the installer found at https://rustup.rs/. Accept all of the defaults.
Close your shell and open a new one (this updates the enviroment).
Then install cargo-vcpkg
, which will help install dependencies for us. You can install it via
cargo install cargo-vcpkg
cargo
is installed with Rust so this should "just work".
Then clone and enter enter the bqskitrs
directory:
git clone https://github.com/BQSKit/bqskitrs.git --recursive
cd bqskitrs
Then build the dependencies with vcpkg.
cargo vcpkg build
This will take quite a while.
Then build the wheel (package file) with maturin:
python -m pip install maturin
python -m maturin build --interpreter $(which python) --features="openblas,openblas-src/system" --release
Finally install the wheel that you built:
pip install --no-index --find-links=target/wheels bqskitrs
Once it is done installing the wheel, verify that the installation succeeded by running
python3 -c 'import bqskitrs'
It should not print anything out nor give any error.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distributions
Hashes for bqskitrs-0.4.0rc2-cp38-abi3-win_amd64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 00dec0899fabd7d21fe9ec3c4d7b0941b0382ddf195e52346121a0fb04977acb |
|
MD5 | b0e9617b32f55f2ee40f7840e4a22585 |
|
BLAKE2b-256 | e55c2af8c00efe6b7e1fb1e5230dbc6cf9bb2a1edf43db6ecbd263f0f13a2435 |
Hashes for bqskitrs-0.4.0rc2-cp38-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3d51f2e413b7c8cf02ae34ab50c2348e9870c11133a7af610cecf9939584b50a |
|
MD5 | dad07b9f94e48682eb50fd65bf44c216 |
|
BLAKE2b-256 | c8da23e4dc7606d217f9a247666e4a1406704a657e6872af1da851230e062491 |
Hashes for bqskitrs-0.4.0rc2-cp38-abi3-macosx_11_0_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5f70ecb7bb770b0310ceb8af0bbb296a2890a7f96f4e43b00a0c7ccc45046d7a |
|
MD5 | 9491725d6e186d78cd179499ad07683c |
|
BLAKE2b-256 | dc74c87ba3bdce878a4da65e215b3cf4934652fc886765584394c8df2f2bdb24 |
Hashes for bqskitrs-0.4.0rc2-cp38-abi3-macosx_11_0_arm64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ada86187b51aaa278658b06b41478885f2a6382f620a0a37c5e78ffd78ca532b |
|
MD5 | 0a7f4049ef7281c91cb1a5df10bc343d |
|
BLAKE2b-256 | 41b7abfde1eaaba9036c68dbba3e8c9f8657b922a0cd0f0bebe47936be06e05b |