Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Minor docs updates #181

Merged
merged 4 commits into from
Feb 3, 2025
Merged

Minor docs updates #181

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8600238
Update user_guide.rst
Misty-W Jan 22, 2025
6920c1f
Symbol update
Misty-W Jan 22, 2025
a9e7b75
Fix import in user_guide.rst
Misty-W Feb 3, 2025
b263301
Update user_guide.rst
Misty-W Feb 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ UCC interfaces automatically with multiple quantum computing frameworks, includi

### Installation

**Note**: UCC requires Python version >= 3.12.
**Note**: UCC requires Python version ≥ 3.12.

```bash
pip install ucc
Expand Down
4 changes: 2 additions & 2 deletions docs/source/user_guide.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ To install ``ucc`` run:
pip install -e . # Editable mode


UCC requires Python version :math:`\ge` 3.12.
UCC requires Python version ≥ 3.12.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No problem from me, but why does this need to change? Seems to be rendering fine: https://ucc.readthedocs.io/en/latest/user_guide.html

Copy link
Collaborator Author

@Misty-W Misty-W Feb 3, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yep RTD is fine either way, but it didn't render in the Markdown preview on our GitHub 😐


Basic usage
***********
Expand All @@ -30,7 +30,7 @@ For example, we can define a random circuit in Qiskit and optimize it using the

from qiskit.circuit.random import random_clifford_circuit
import ucc
from ucc.benchmarks.utils import count_multi_qubit_gates_qiskit
from benchmarks.utils import count_multi_qubit_gates_qiskit
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For me, I had to switch this to from benchmarks.scripts.common as the utils submodule didn't exist.

But also curious, do we want benchmarks to be a submodule of ucc or a sibling?

Copy link
Collaborator Author

@Misty-W Misty-W Feb 3, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks Brad. I think it's more intuitive to have benchmarks as a submodule of ucc. I think the benchmarks module was intentionally made a sibling of ucc during earlier restructuring of the library, but I don't remember the reason. Jordan likely has more context.



gates = ["cx", "cz", "cy", "swap", "x", "y", "z", "s", "sdg", "h"]
Expand Down