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.0rc1-cp38-abi3-win_amd64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e643e111ab28c2fd1f4041551fd50d51f2f3e9fcb4d3adac66820b47fd53e3f6 |
|
MD5 | b782bdd30ea353cd60ad613cafca43f1 |
|
BLAKE2b-256 | ffc5437ab1f12953fac4795d4eef6d8a203b71ac5fd6ffe19cf155d1c68217e6 |
Hashes for bqskitrs-0.4.0rc1-cp38-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ad3812633277d6936bfff98adfd71fb0c475423e62862baa2b5d9fa996086cae |
|
MD5 | e83e5bbc9ae164bdab369ebc17ca40e2 |
|
BLAKE2b-256 | bcc6e79da8de403f7508587c30f4e9203721d815ebb458ae2d8b0b27772b2a9d |
Hashes for bqskitrs-0.4.0rc1-cp38-abi3-macosx_11_0_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ac445944d46795d5aee5db0e440f5c6d247550c4d381ea11905407a89d7b7c3f |
|
MD5 | 32f01b1e893986b76db82889c4eb7992 |
|
BLAKE2b-256 | 1a49fcf40c146ca5ab64b17fa353b1887960aa5411b8143089667c61be248717 |
Hashes for bqskitrs-0.4.0rc1-cp38-abi3-macosx_11_0_arm64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5fe8170adc73a8182dd8ca7ea97621abe5df23c3f37041643372c28bc2221789 |
|
MD5 | 7373610ef6dcaa66dc0135cf2a691c27 |
|
BLAKE2b-256 | fe9c19a455019b92329664279a39eb3ac49801036552517fa9b6dbd73add77ab |