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

Uploaded CPython 3.9+Windows x86-64

qurrium-0.10.0-cp39-abi3-win32.whl (318.3 kB view details)

Uploaded CPython 3.9+Windows x86

qurrium-0.10.0-cp39-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (750.1 kB view details)

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

qurrium-0.10.0-cp39-abi3-manylinux_2_17_i686.manylinux2014_i686.whl (772.1 kB view details)

Uploaded CPython 3.9+manylinux: glibc 2.17+ i686

qurrium-0.10.0-cp39-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl (736.0 kB view details)

Uploaded CPython 3.9+manylinux: glibc 2.17+ ARM64

qurrium-0.10.0-cp39-abi3-macosx_11_0_arm64.whl (724.2 kB view details)

Uploaded CPython 3.9+macOS 11.0+ ARM64

qurrium-0.10.0-cp39-abi3-macosx_10_12_x86_64.whl (738.5 kB view details)

Uploaded CPython 3.9+macOS 10.12+ x86-64

qurrium-0.10.0-cp39-abi3-macosx_10_12_universal2.whl (1.1 MB view details)

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

File details

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

File metadata

  • Download URL: qurrium-0.10.0-cp39-abi3-win_amd64.whl
  • Upload date:
  • Size: 788.9 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.0-cp39-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 597d54966356c621ad3c19d392b7794d7dee3852bde1f941ee4b095fc06661d6
MD5 25d9200d15747d73ea8ef4ca785c62f1
BLAKE2b-256 131641d8a166cf177cb3c6c4722e71da735dd8adfef032f58aabaea89193fd01

See more details on using hashes here.

File details

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

File metadata

  • Download URL: qurrium-0.10.0-cp39-abi3-win32.whl
  • Upload date:
  • Size: 318.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.0-cp39-abi3-win32.whl
Algorithm Hash digest
SHA256 2eb4671c2a2a36a30ed5f47a6d83344399eb53be36f0a5938b21494b6bb09561
MD5 2f3bf67b5cb0ab7f3a909268c681ea8e
BLAKE2b-256 048f93abc77e85665e4b66e968e04a9eaa5f5e8158dc99cde7bc9087366bb1b5

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for qurrium-0.10.0-cp39-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 beabca020ffca0e8847f55ada5552ef45c167e4d3a11f6dda4e10b5140f7793c
MD5 2d9bfc9bc4285adf4996f989b37d33f9
BLAKE2b-256 4025fedd4caf5a6db7598dd9bb63cf27da3c98ec59ec7c60674f2284b26ec8ad

See more details on using hashes here.

Provenance

The following attestation bundles were made for qurrium-0.10.0-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.0-cp39-abi3-manylinux_2_17_i686.manylinux2014_i686.whl.

File metadata

File hashes

Hashes for qurrium-0.10.0-cp39-abi3-manylinux_2_17_i686.manylinux2014_i686.whl
Algorithm Hash digest
SHA256 004ba984e4d6eefd7809fa34bcd887dc7d50c0999ebd4a403c284a2f61249442
MD5 f12279b6264bda102e1c77c0c1d7ee3f
BLAKE2b-256 d27d8618e2a8da93d73972144c2ceeeac8727d50490419be1e0dded952b1605d

See more details on using hashes here.

Provenance

The following attestation bundles were made for qurrium-0.10.0-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.0-cp39-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl.

File metadata

File hashes

Hashes for qurrium-0.10.0-cp39-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
Algorithm Hash digest
SHA256 f6c439809148fbd854179717bd5ffb14da2631f19193d5dbc6e1c754b9af90dc
MD5 bd9575f43d8e15e85a5a509f0ae2f26a
BLAKE2b-256 8b14d92ab02bd66fa91812a4c1ab8d840c4ac29e25e8efa8a204ed04911dc967

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for qurrium-0.10.0-cp39-abi3-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 600b1cad044c09bf0c2643919c0b730c9d6ab2117f72aca9eb2cbc518c294f95
MD5 40044e1ba202c36a74bd8e7a207d2785
BLAKE2b-256 98766df3a2438305990e967ecf68b8cc3fd934ed164c191d6c83240c460fb7b6

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for qurrium-0.10.0-cp39-abi3-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 f563b1d56e000aef63493ce944b9f5396953c996c9b885763119a5280c512a72
MD5 f0ced4e7767834f006521da7873d20d4
BLAKE2b-256 71b264e3a1bb35461c9f6f2bebbe1d5e453d5e67b13299ff97854e899d70b156

See more details on using hashes here.

Provenance

The following attestation bundles were made for qurrium-0.10.0-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.0-cp39-abi3-macosx_10_12_universal2.whl.

File metadata

File hashes

Hashes for qurrium-0.10.0-cp39-abi3-macosx_10_12_universal2.whl
Algorithm Hash digest
SHA256 1a66ccd4dd2aa231cade765c1f10a43f26c707f0fd0dab3e04d230d7141aebd2
MD5 5eaaf37797ff1b421b02130e62e2647c
BLAKE2b-256 5ede285ffbefd498a416427ce27c39dc4812216b209b542893bdd0aeefa7bb28

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