Skip to main content

Qurry 🍛 - The Measuring Tool for Renyi Entropy, Loschmidt Echo, and Magnetization Squared, The Library of Some Common Cases

Project description

Qurry 🍛 - The python package for measuring quantum entanglement entropy and wave function overlap.

The python package that makes the randomized measurement easy.

The major function includes the measurement of quantum Renyi Entropy and Wave Function Overlap based on the randomized measurement protocol. When interfaced with IBM Qiskit, the package automates the workflow from creating experiment objects, job submission and recall and postprocessing.
There are several additional features, such as measurement of magnetization and error mitigation. Please check them out!

Available Python Version Downloads Available System Available System Available System Available System

Installation

By PyPI - Stable Release

  • The package can be found in pip list as qurrium-x.y.z
  • Pip downloads the most stable release, but not necessarily the latest version.
pip install qurrium

By TestPyPI - Nightly Release

  • This package can be found in pip list as qurry-x.y.z.devW
  • This version includes new features and minor bug fixes, but may not be stable.
pip install qiskit tqdm requests
# the installation from testPyPI can' t find these dependencies
pip install -i https://test.pypi.org/simple/ qurry

Maually by Git

Qurry can be installed from source. Since this package relies on Cython and Rust, it requires "C complier" and "Rust complier" which you need to install first.

To install rust, run the following command:

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

Then install qurry by the following command:

git clone https://github.com/harui2019/qurry-preview.git --recursive
cd qurry
pip install -e .

Test Installation

pytest is used for testing. Simply run the following command after the installation:

pytest

Environment

Qurry currently SUPPORT qiskit 0.46.0+ and qiskit 1.0.0+, other lower versions are no longer available. The package has been tested on the following systems.

  • Ubuntu 18.04+ LTS (All ManyLinux 2014 compatible distro)

    • on x86_64 (recommended)
    • on x86_64 Windows 10/11 WSL2 (recommended)
    • on aarch64
    • We strongly recommend to use Linux based systems because Python multiprocessing may exist issues on Windows and the NVIDIA CUDA acceleration of Qiskit, qiskit-aer-gpu are supported only on Linux.
  • Windows 10/11

    • on x86_64
  • MacOS 11+

    • on aarch64 (Apple Silicon, M1/M2/M3/M4 chips)
    • on x86_64 (Intel chips)

The depedent modules are as follows.

  • with required modules:
  • with optional modules:
    • qiskit-aer: The complete simulator package of qiskit
    • qiskit-aer-gpu: The gpu acceleration of qiskit-aer on Linux with Nvidia GPU
      • qiskit-aer-gpu-cu11: A package for CUDA 11
    • qiskit-ibm-runtime: The API to access IBM Quantum Device
    • qiskit-ibm-provider: The API to access IBM Quantum Device, but will be deprecated soon.
    • qiskit-ibmq-provider: The API to access IBM Quantum Device, which has been deprecated.

Measurement -- made randomized measurement easy.

qurrent - The Quantum Renyi Entropy Measurement

The major function of this module is to measure the quantum Renyi entropy to quantify entanglement.

qurrech - The Wave Function Overlap Measurement

This module evaluates the overlap between any two given quantum states.

In each of the modules, two methods are implemented to perform the measurements:

  • Hadamard Test

    • Ref: Entanglement spectroscopy on a quantum computer - Sonika Johri, Damian S. Steiger, and Matthias Troyer, PhysRevB.96.195136
  • Haar Randomized Measure

    • Ref: Statistical correlations between locally randomized measurements: A toolbox for probing entanglement in many-body quantum states - A. Elben, B. Vermersch, C. F. Roos, and P. Zoller, PhysRevA.99.052323

Citation

If you use this tool in your research, please cite the following paper in your publication:

@misc{chang2024probing,
  title         = {Probing entanglement dynamics and topological transitions on noisy intermediate-scale quantum computers},
  author        = {Huai-Chun Chang and Hsiu-Chuan Hsu and Yu-Cheng Lin},
  year          = {2024},
  eprint        = {2406.10159},
  archiveprefix = {arXiv},
  primaryclass  = {quant-ph},
  url           = {https://arxiv.org/abs/2406.10159}
}

Acknowledgments

The authors acknowledge the support from National Chengchi University, NSTC-Quantum Virtual Machine project, National Center for Theoretical Sciences (NCTS). and IBM Quantum Hub at National Taiwan University (NTU).

Special thank to IBM Quantum Hub at NTU for providing the access right of IBM Quantum that allows us to fully test the tool and execute our experiments.

The author @harui2019 is grateful to the NTU hub of NCTS that supported him as a Research Assistiant in the early stage of the development.

National Chengchi University

NSTC

National Center for Theoretical Sciences, Physics Division

IBM Quantum Hub at National Taiwan University


Stay connected. More features coming soon...

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distributions

If you're not sure about the file name format, learn more about wheel file names.

qurrium-0.9.0-cp312-cp312-macosx_10_13_x86_64.whl (806.3 kB view details)

Uploaded CPython 3.12macOS 10.13+ x86-64

qurrium-0.9.0-cp311-cp311-macosx_10_12_x86_64.whl (805.4 kB view details)

Uploaded CPython 3.11macOS 10.12+ x86-64

qurrium-0.9.0-cp310-cp310-macosx_10_12_x86_64.whl (805.5 kB view details)

Uploaded CPython 3.10macOS 10.12+ x86-64

qurrium-0.9.0-cp39-cp39-macosx_10_12_x86_64.whl (805.5 kB view details)

Uploaded CPython 3.9macOS 10.12+ x86-64

qurrium-0.9.0-cp39-abi3-win_arm64.whl (465.0 kB view details)

Uploaded CPython 3.9+Windows ARM64

qurrium-0.9.0-cp39-abi3-win_amd64.whl (939.8 kB view details)

Uploaded CPython 3.9+Windows x86-64

qurrium-0.9.0-cp39-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (2.0 MB view details)

Uploaded CPython 3.9+manylinux: glibc 2.17+ x86-64

qurrium-0.9.0-cp39-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl (2.0 MB view details)

Uploaded CPython 3.9+manylinux: glibc 2.17+ ARM64

qurrium-0.9.0-cp39-abi3-manylinux_2_12_i686.manylinux2010_i686.manylinux_2_17_i686.manylinux2014_i686.whl (2.0 MB view details)

Uploaded CPython 3.9+manylinux: glibc 2.12+ i686manylinux: glibc 2.17+ i686

qurrium-0.9.0-cp39-abi3-macosx_11_0_arm64.whl (793.4 kB view details)

Uploaded CPython 3.9+macOS 11.0+ ARM64

File details

Details for the file qurrium-0.9.0-cp312-cp312-macosx_10_13_x86_64.whl.

File metadata

File hashes

Hashes for qurrium-0.9.0-cp312-cp312-macosx_10_13_x86_64.whl
Algorithm Hash digest
SHA256 fb6f13a68b98a4fb760e7c0244ffd97406d96f451e848b8f6195a5ecbe923dbb
MD5 e51c28c79d745d2a963ccf4e7f8ff8cc
BLAKE2b-256 873a4b728e61e6a45a7bbe5250c8662888f748ecf623ec6706afd28aabf9ee48

See more details on using hashes here.

File details

Details for the file qurrium-0.9.0-cp311-cp311-macosx_10_12_x86_64.whl.

File metadata

File hashes

Hashes for qurrium-0.9.0-cp311-cp311-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 4a41dcd9c6a4eb621697604ad9fd59b79d95ed9f9d468514f167b16dc1c54fd1
MD5 bd32e194e8916a135876d3d83c5ba1d4
BLAKE2b-256 74b8a1bfd3b486d445b842752e03e98d09536e3df8a5710b5505742d700e426c

See more details on using hashes here.

File details

Details for the file qurrium-0.9.0-cp310-cp310-macosx_10_12_x86_64.whl.

File metadata

File hashes

Hashes for qurrium-0.9.0-cp310-cp310-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 98e80a10c6b834155c9262e9377dbb4effe923c3c4d40a193dadf51059bfd1f5
MD5 225e1a1852815bf13c42282a02b02be7
BLAKE2b-256 9d8e27feaf50f73550e25c5f7b0032f81d7961a6a977b98fe5109705012a8f18

See more details on using hashes here.

File details

Details for the file qurrium-0.9.0-cp39-cp39-macosx_10_12_x86_64.whl.

File metadata

File hashes

Hashes for qurrium-0.9.0-cp39-cp39-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 44fdd8152d42b93938e308da85fe8da6279312bd830262532e0d6dadcdf2aa94
MD5 816983c889959bd48f539fde273fb3f0
BLAKE2b-256 49b9e647cf467b04ef1fd0c1b6a0b8e93ee12362394024de51cc43c2f859622c

See more details on using hashes here.

File details

Details for the file qurrium-0.9.0-cp39-abi3-win_arm64.whl.

File metadata

  • Download URL: qurrium-0.9.0-cp39-abi3-win_arm64.whl
  • Upload date:
  • Size: 465.0 kB
  • Tags: CPython 3.9+, Windows ARM64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.5

File hashes

Hashes for qurrium-0.9.0-cp39-abi3-win_arm64.whl
Algorithm Hash digest
SHA256 bff8c09f8b306077d03b6231e5db3fe47bacf6ac1393412d06a4053e11257012
MD5 8f1a98df9461187cfd31cc732618b191
BLAKE2b-256 ff4f311a9426ee1d9c43b0ee592eda184b117e993894d9f3e5a68de54f06b902

See more details on using hashes here.

File details

Details for the file qurrium-0.9.0-cp39-abi3-win_amd64.whl.

File metadata

  • Download URL: qurrium-0.9.0-cp39-abi3-win_amd64.whl
  • Upload date:
  • Size: 939.8 kB
  • Tags: CPython 3.9+, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.5

File hashes

Hashes for qurrium-0.9.0-cp39-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 aea1136f15717014255faa84c99ed939e1e71f2597b3553ce23aa0cfb39330aa
MD5 63a61b3ad9993b93d819535043163b28
BLAKE2b-256 2875729332dc4fc483b1f293778df579b71636f4d1e87b62be9ad343019a0e21

See more details on using hashes here.

File details

Details for the file qurrium-0.9.0-cp39-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for qurrium-0.9.0-cp39-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 6756fc6bbe7eed668379e4ce4f2c8e2730a3a1e6253eb8e36332b37c422cf262
MD5 97fedaab3b396c2fa88f64a2c6c2c039
BLAKE2b-256 4e1460800eb74ee08cb29e42f9238d7afa054da3ba83d1fe8b76ceddb71e0727

See more details on using hashes here.

File details

Details for the file qurrium-0.9.0-cp39-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl.

File metadata

File hashes

Hashes for qurrium-0.9.0-cp39-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
Algorithm Hash digest
SHA256 dc78cc897d549b2a8468745802a8316f161ba27b087967b983037c7776461bc0
MD5 f60f661acb2b97c024e0c629bb859612
BLAKE2b-256 632c452fee782b030f6fea2651e54985034608596b18bd09399f4e320fd98c5c

See more details on using hashes here.

File details

Details for the file qurrium-0.9.0-cp39-abi3-manylinux_2_12_i686.manylinux2010_i686.manylinux_2_17_i686.manylinux2014_i686.whl.

File metadata

File hashes

Hashes for qurrium-0.9.0-cp39-abi3-manylinux_2_12_i686.manylinux2010_i686.manylinux_2_17_i686.manylinux2014_i686.whl
Algorithm Hash digest
SHA256 6a3dd670a8fea06bd1bb84d0bc18b5b0155014ee2b38da2939e9f4345723b869
MD5 c47fd3fd0e5c018408c370e9486b99fc
BLAKE2b-256 001fd98d9ac73117db58e0eae3c113cb3df3ba060e696a0acd695bc189510333

See more details on using hashes here.

File details

Details for the file qurrium-0.9.0-cp39-abi3-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for qurrium-0.9.0-cp39-abi3-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 d57c344627feaadb25d079556366ae3fbd61e0a21afd65a419d978f7de454253
MD5 0ae9f20e4c7ca45a145968d561064994
BLAKE2b-256 43fcffc345e97653a818f8784be976c8d7848d4d08058a5381d84e71eab48c74

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page