Skip to content

Commit

Permalink
Add warning about Tweedledum support in ClassicalFunction
Browse files Browse the repository at this point in the history
  • Loading branch information
weechinghwa committed Jun 25, 2024
1 parent 8b1f75f commit 1a2c08e
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions qiskit/circuit/classicalfunction/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,12 @@ def grover_oracle(a: Int1, b: Int1, c: Int1, d: Int1) -> Int1:
Following Qiskit's little-endian bit ordering convention, the left-most bit (``a``) is the most
significant bit and the right-most bit (``d``) is the least significant bit.
.. warning::
The functionality of `qiskit.circuit.classicalfunction` requires the `tweedledum` package,
which isn't available on all platforms (up to Python version 3.11).
See `tweedledum installation guide <https://github.com/boschmitt/tweedledum/tree/master?tab=readme-ov-file#installation>`_ for more details.
Supplementary Information
=========================
Expand Down

0 comments on commit 1a2c08e

Please sign in to comment.