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

Documentation

More infomation can be found in the documentation of Qurry 🍛.

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.10.1-cp39-abi3-win_amd64.whl (577.5 kB view details)

Uploaded CPython 3.9+Windows x86-64

qurrium-0.10.1-cp39-abi3-win32.whl (310.3 kB view details)

Uploaded CPython 3.9+Windows x86

qurrium-0.10.1-cp39-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (749.7 kB view details)

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

qurrium-0.10.1-cp39-abi3-manylinux_2_17_i686.manylinux2014_i686.whl (771.6 kB view details)

Uploaded CPython 3.9+manylinux: glibc 2.17+ i686

qurrium-0.10.1-cp39-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl (735.6 kB view details)

Uploaded CPython 3.9+manylinux: glibc 2.17+ ARM64

qurrium-0.10.1-cp39-abi3-macosx_11_0_arm64.whl (686.2 kB view details)

Uploaded CPython 3.9+macOS 11.0+ ARM64

qurrium-0.10.1-cp39-abi3-macosx_10_12_x86_64.whl (738.1 kB view details)

Uploaded CPython 3.9+macOS 10.12+ x86-64

qurrium-0.10.1-cp39-abi3-macosx_10_9_universal2.whl (1.1 MB view details)

Uploaded CPython 3.9+macOS 10.9+ universal2 (ARM64, x86-64)

File details

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

File metadata

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

File hashes

Hashes for qurrium-0.10.1-cp39-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 a88025f856ff830f44b9f6b5d5742e812247a766c11e3aca046cbafaf25959d6
MD5 9d067593042b0a2a065d462a735da4df
BLAKE2b-256 01628a6c3a8c98e6bc846f84221f8c088ecb305232edcd4533a7cdca609c4602

See more details on using hashes here.

File details

Details for the file qurrium-0.10.1-cp39-abi3-win32.whl.

File metadata

  • Download URL: qurrium-0.10.1-cp39-abi3-win32.whl
  • Upload date:
  • Size: 310.3 kB
  • Tags: CPython 3.9+, Windows x86
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for qurrium-0.10.1-cp39-abi3-win32.whl
Algorithm Hash digest
SHA256 7b4e23cea5c1ff9496307b6da4b75d39f1d409f3b3e18aff3c976759a2ee4334
MD5 9bb7440744b1883edf6fecbd74d84884
BLAKE2b-256 e3542f729fcf7dedfe587f7e3a5672e267a7b75e058978066c1db4a59c1e72a6

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for qurrium-0.10.1-cp39-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 f9db30d3c44bface7ea7126b4a859f2d759a7e2906f5b8b7b4cd30a0e354ee55
MD5 dd696ae702b59929a9291caaa685876a
BLAKE2b-256 f03905067b877b17488985bd8471e13e6e29a3d3cc28dc2518f1bf1f66de157d

See more details on using hashes here.

Provenance

The following attestation bundles were made for qurrium-0.10.1-cp39-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl:

Publisher: wheel-stable.yml on harui2019/qurry

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file qurrium-0.10.1-cp39-abi3-manylinux_2_17_i686.manylinux2014_i686.whl.

File metadata

File hashes

Hashes for qurrium-0.10.1-cp39-abi3-manylinux_2_17_i686.manylinux2014_i686.whl
Algorithm Hash digest
SHA256 b7fc673b785a6ca858b5c5b4d525b1acb2005ab5f2b460f604a190a5ea9a436f
MD5 ef4d3e52453ec02fd2c83c89efba5b2b
BLAKE2b-256 916fbb70219aa587afbbca98b357a78dd01c6219e0f90c684e911311f634d12b

See more details on using hashes here.

Provenance

The following attestation bundles were made for qurrium-0.10.1-cp39-abi3-manylinux_2_17_i686.manylinux2014_i686.whl:

Publisher: wheel-stable.yml on harui2019/qurry

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

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

File metadata

File hashes

Hashes for qurrium-0.10.1-cp39-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
Algorithm Hash digest
SHA256 11c84ba9fbe4be81034911127a7021d480991936c2f10626bc8af599ebc5dabc
MD5 d472ce35a70931afec55dde98a3b8527
BLAKE2b-256 509b929782d03a9f1665b65d7d6ca62952d4c6f3aeed4012b62f89b5425d0162

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for qurrium-0.10.1-cp39-abi3-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 dd2ba2a51fce439dde456c2c29896cc87510ad3d7c90bee2fa57a45bcfae080f
MD5 9a4944ec42542590ec76c1f3fbda808d
BLAKE2b-256 e0f36dea2a16df77969fa6bbad0568730b9ae89b71e16d7d556d251c2467971c

See more details on using hashes here.

File details

Details for the file qurrium-0.10.1-cp39-abi3-macosx_10_12_x86_64.whl.

File metadata

File hashes

Hashes for qurrium-0.10.1-cp39-abi3-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 35760d4934da4ed83256bbfafb2b59d66e1d09fc982a2d66de831c95b419e568
MD5 20cefb964572c31a4b75b372d9023351
BLAKE2b-256 060b1bdbeac3ab87f2eb5d437ec2db281edcb309d1d51af52f9a59412f0479d3

See more details on using hashes here.

Provenance

The following attestation bundles were made for qurrium-0.10.1-cp39-abi3-macosx_10_12_x86_64.whl:

Publisher: wheel-stable.yml on harui2019/qurry

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file qurrium-0.10.1-cp39-abi3-macosx_10_9_universal2.whl.

File metadata

File hashes

Hashes for qurrium-0.10.1-cp39-abi3-macosx_10_9_universal2.whl
Algorithm Hash digest
SHA256 2f24e075153b74a3f36a5aaa33c22e9bafe73ac607d4ebf7c29b9312a351c6e1
MD5 41bea4807f3c54465faeb4e6a8a87eed
BLAKE2b-256 b40e8feb4464a13605c3c3f14b94813dac44aa315f9f5847f0c25ace0ac8cc94

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