API

This page contains all API reference for Qurrium.

Process

Post-processing module for Qurrium (qurry.process)

  • All post-processing modules are here.

  • This module should be no dependency on qiskit.

Post-Processing Utilties

Post-Processing Functions

Declare

Declaration (qurry.declare)

TypedDicts for some complex data structures

Declare

Tools

Tools (qurry.tools)

Tools

Recipe

Qurrium Recipe - The Simple Case Library (qurry.recipe)

Recipe

Capsule

Files writing, reading, and something interesting?

Capsule

Qurrent

Division for entangled entropy.

Qurrent/Qurshady - Second Renyi Entropy Measurement/Classical Shadow (qurry.qurrent)

Tip

  1. The name “qurrent” was the second proposed name for this package. It’s not simply “current” with a “q” replacing the “c”, but rather a combination of “qurr” and “ent”, where “ent” abbreviates “entropy”, and “qurr” is a coined prefix beginning with “qu” to imply “quantum”.

  2. The initial proposed name for the package was “xproc”, short for “experimental process”.

  3. Another module, “qurrech”, combines “qurr” with “ech”, where “ech” is short for “echo”, the Loschmidt echo being a key concept in quantum information theory. This inspired us to adopt “qurry”, derived from “qurr” and the suffix “ry”, to resemble words like “query” or “curry”.

  4. Since a package named “qurry” already exists on PyPI, and many projects on GitHub also use this name, we changed the suffix from “y” to “ium”, creating “qurrium”. “Qurrium” is unique and easily searchable, with no prior use on PyPI or in general web searches.

  5. So there is the evolution of the package name: xproc -> qurrent -> qurry -> qurrium

qurry.qurrent.EntropyMeasure(*args, method: Literal['hadamard'], **kwargs) → EntropyMeasureHadamard[source]
qurry.qurrent.EntropyMeasure(*args, method: Literal['randomized_v1'], **kwargs) → EntropyMeasureRandomizedV1
qurry.qurrent.EntropyMeasure(*args, method: Literal['randomized', 'haar', 'base'] | str = 'randomized', **kwargs) → EntropyMeasureRandomized
qurry.qurrent.EntropyMeasure(*args, method: Literal['classical_shadow'], **kwargs) → ShadowUnveil

Call EntropyMeasure methods.

Parameters:

method (Literal['randomized', 'hadamard', 'base'], optional) –

  • randomized: running by haar randomized measure.

  • hadamard: running by hadamard test.

  • base: the base of EntropyMeasure.

Defaults to ‘randomized’.

Returns:

method.

Return type:

Union[EntropyMeasureBase, EntropyMeasureV2Base]

Qurrent

Qurrech

Division for wave fucnction overlap.

Qurrech - Wave Function Overlap (qurry.qurrech)

qurry.qurrech.EchoListen(*args, method: Literal['hadamard'], **kwargs) → EchoListenHadamard[source]
qurry.qurrech.EchoListen(*args, method: Literal['randomized_v1'], **kwargs) → EchoListenRandomizedV1
qurry.qurrech.EchoListen(*args, method: Literal['randomized', 'base'] | str = 'randomized', **kwargs) → EchoListenRandomized

Call EchoListen methods.

Parameters:

method (Literal['randomized', 'hadamard&#39], optional) –

  • randomized: running by haar randomized measure.

  • hadamard: running by hadamard test.

Defaults to ‘randomized’.

Returns:

method.

Return type:

EchoListenBase

qurry.qurrech.WaveFunctionOverlap(*args, method: Literal['hadamard'], **kwargs) → EchoListenHadamard[source]
qurry.qurrech.WaveFunctionOverlap(*args, method: Literal['randomized_v1'], **kwargs) → EchoListenRandomizedV1
qurry.qurrech.WaveFunctionOverlap(*args, method: Literal['randomized', 'base'] | str = 'randomized', **kwargs) → EchoListenRandomized

Call WaveFunctionOverlap methods, another name of EchoListen.

Parameters:

method (Literal['randomized', 'hadamard&#39], optional) –

  • randomized: running by haar randomized measure.

  • hadamard: running by hadamard test.

Defaults to ‘randomized’.

Returns:

method.

Return type:

WaveFunctionOverlapBase

Qurrech

Qurries

Division for all other implementation.

Qurries - Other Qurrium Modules (qurry.qurries)

  • TwistedOperator - Twisted Operator (Proposal)

    • Formerly known as qurtwistop

Qurries

Qurrium

Core modules for Qurrium

Qurrium - A Qiskit Macro (qurry.qurrium)

Qurrium

Exception

Exception of Qurrium.

Exception

Template of API

Template of API