v0.4.2

[Misty-W]

Introductory release of the Unitary Compiler Collection (UCC)

Version 0.4.2 marks the first formal release to PyPI of the Unitary Compiler Collection (UCC), a Python library for frontend-agnostic, high performance compilation of quantum circuits.

This release contains the default UCC compilation workflow, including circuit translation and optimization passes, pass management, and the user interface. It also encompasses benchmarking scripts and utilities, tests, documentation, and basic infrastructure.

Full Changelog: https://github.com/unitaryfund/ucc/commits/v0.4.2

All PRs

• First version of default UCC by @sonikaj in First version of default UCC #10
• Fixed issues with inflation of 1Q gates and now has support (under input constraints) for parameterized gates by @sonikaj in Fixed issues with inflation of 1Q gates and now has support (under input constraints) for parameterized gates #22
• Add CX cancellation pass by @Misty-W in Add CX cancellation pass #24
• Add unit tests for CX_Cancellation pass by @Misty-W in Add unit tests for CX_Cancellation pass #27
• Moved cx_cancelation into transpiler_passes with other passes by @jordandsullivan in Moved cx_cancelation into transpiler_passes with other passes #33
• Removing extraneous code for MVP by @jordandsullivan in Removing extraneous code for MVP  #37
• Update README.md with license notice by @nathanshammah in Update README.md with license notice #38
• 23 remove quantumtranslator references by @jordandsullivan in 23 remove quantumtranslator references #31
• Add basic circuit equivalence check by @natestemen in Add basic circuit equivalence check #43
• 2 add benchmarks by @jordandsullivan in 2 add benchmarks #42
• 18 mapping by @sonikaj in 18 mapping #41
• Update Readme to reflect AGPLv3 by @jordandsullivan in Update Readme to reflect AGPLv3 #49
• Add Qiskit CollectCliffordspass to UCC defaults by @Misty-W in Add Qiskit CollectCliffordspass to UCC defaults #61
• Add documentation by @natestemen in Add documentation #67
• specify Python version 3.12 in readme and setup.py by @willzeng in specify Python version 3.12 in readme and setup.py #76
• Change Cirq dependency to cirq-core and support Python 3.13. by @Misty-W in Change Cirq dependency to cirq-core and support Python 3.13. #77
• update readme to use current API by @willzeng in update readme to use current API #79
• Create user guide by @Misty-W in Create user guide #73
• Add benchmark script by @jordandsullivan in Add benchmark script #65
• remove inaccurate data by @jordandsullivan in remove inaccurate data #87
• New Clifford pass sequence by @Misty-W in New Clifford pass sequence #90
• Test that gateset is preserved by @Misty-W in Test that gateset is preserved #84
• Move and expand test for logical equivalence by @Misty-W in Move and expand test for logical equivalence #92
• add basic expectation value benchmark by @natestemen in add basic expectation value benchmark #96
• 97 reorg files by @jordandsullivan in 97 reorg files #98
• merge in new shell script changes by @jordandsullivan in merge in new shell script changes #104
• 93 set up aws workflow for benchmarking by @jordandsullivan in 93 set up aws workflow for benchmarking #108
• Update PTKET rebase pass with new API by @jordandsullivan in Update PTKET rebase pass with new API #105
• Revert accidental merge "93 set up aws workflow for benchmarking" by @jordandsullivan in Revert accidental merge "93 set up aws workflow for benchmarking" #112
• Pin to Qiskit 1.2 temporarily by @jordandsullivan in Pin to Qiskit 1.2 temporarily #117
• 58 run first hardware benchmarks by @jordandsullivan in 58 run first hardware benchmarks #110
• Replace RebaseTKET with AutoRebase by @jordandsullivan in Replace RebaseTKET with AutoRebase #121
• Add paralellism flag and autokill subprocess jobs by @jordandsullivan in Add paralellism flag and autokill subprocess jobs #100
• Add GH Action for benchmarking by @jordandsullivan in Add GH Action for benchmarking #130
• Update with new Cirq API by @jordandsullivan in Update with new Cirq API #127
• Update Dockerfile to install parallel package by @jordandsullivan in Update Dockerfile to install parallel package #131
• Use Qiskit ConsolidateBlocks instead of UCC customized pass by @Misty-W in Use Qiskit ConsolidateBlocks instead of UCC customized pass #119
• 101 clean up unnecessary files by @jordandsullivan in 101 clean up unnecessary files #124
• Point to correct branch by @jordandsullivan in Point to correct branch #139
• Switch to 8 core runner, same paralellism by @jordandsullivan in Switch to 8 core runner, same paralellism #141
• Add proposed release workflow by @natestemen in Add proposed release workflow #137
• Add info about ucc.supported_formats, update QASM links, add docs ins… by @jordandsullivan in Add info about ucc.supported_formats, update QASM links, add docs ins… #143
• 123 save compiler versions with data by @jordandsullivan in 123 save compiler versions with data #134
• 114 generate plot via Github Actions pipeline by @jordandsullivan in 114 generate plot via Github Actions pipeline #133
• Re-organize files so QASM circuits live in a different directory than… by @jordandsullivan in Re-organize files so QASM circuits live in a different directory than… #128
• Add CI for testing by @natestemen in Add CI for testing #135
• 148 mismatched headers in datafiles by @jordandsullivan in 148 mismatched headers in datafiles #150
• fix small_test.sh CLI command to deal with spaces in paths by @willzeng in fix small_test.sh CLI command to deal with spaces in paths #152
• 53 display most recent benchmarks by @jordandsullivan in 53 display most recent benchmarks #151
• Start a contributor docs section in the README by @willzeng in Start a contributor docs section in the README #153
• Pin qiskit-qasm3-import version to 0.5.1 by @Misty-W in Pin qiskit-qasm3-import version to 0.5.1  #160
• Fresh benchmarks on multiple layouts by @Misty-W in Fresh benchmarks on multiple layouts #142
• Reorganize code structure by @Misty-W in Reorganize code structure #162
• Working OS info save function by @jordandsullivan in Working OS info save function #163
• Contributing guide + Read the Docs config by @natestemen in Contributing guide + Read the Docs config #166
• Use the VF2 layout algorithm to optimize for two-qubit gate count by @Misty-W in Use the VF2 layout algorithm to optimize for two-qubit gate count #169
• Prep for pypi release by @Misty-W in Prep for pypi release #171
• 145 plot compiler versions over time on graph by @jordandsullivan in 145 plot compiler versions over time on graph #173
• 167 add readmemd to documentation by @jordandsullivan in 167 add readmemd to documentation #174
• Update README.md by @willzeng in Update README.md #178
• Add explicit Sphinx config in .readthedocs.yaml file by @Misty-W in Add explicit Sphinx config in .readthedocs.yaml file #180
• Plot adjustments by @jordandsullivan in Plot adjustments #183
• merge in main by @jordandsullivan in merge in main #192
• Test deploy key push acess by @jordandsullivan in Test deploy key push acess #197
• Wording by @jordandsullivan in Wording #198
• Roll version for packaging fix by @Misty-W in Roll version for packaging fix #175

UCC team: @jordandsullivan, @Misty-W, @nathanshammah, @natestemen, @willzeng

with thanks to @sonikaj for research and early prototyping.

---

This discussion was created from the release v0.4.2.