Search-Based Quantum Synthesis/Compilation
This is an implementation of the algorithm described in the paper Heuristics for Quantum Compiling with a Continuous Gate Set.
This is a python package which can be installed using pip. You will need a Python version of at least 3.6. The search compiler currently only runs on macOS, Linux, and the Windows Subsystem for Linux. You can install it from PyPi using:
pip3 install search_compiler
You can also install from a downloaded copy of the repository:
git clone email@example.com:WolfLink/search_compiler.git pip3 install ./search_compiler
If you make changes to your local copy, you can reinstall the package:
pip3 install --upgrade ./search_compiler
Once installed, you can import the library like any other python package:
import search_compiler as sc
There is a gateset that is implemented in native code to be faster. See the wiki for installation instructions.
Getting Started: search_compiler Projects
The simplest way to use the search_compiler library is by using a Project. When you create a project, you provide a path where a directory will be created to contain the project's files.
import search_compiler as sc myproject = sc.Project("desired/path/to/project/directory")
You can then add unitaries to compile, and set compiler properties. Unitary matrices should be provided as
numpy ndarrays using
myproject.add_compilation("gate_name", gate_unitary) myproject["compiler_option"] = value
Once your project is configured, you can start your project by calling
run(). The compiler uses an automatic checkpoint system, so if it is killed while in-progress, it can be resumed by calling
Once your project is finished, you can get openqasm output:
myproject.assemble("gate_name") # This will write the qasm to stdout myproject.assemble("gate_name", write_location="path/to/output/file") # This will write the qasm to the specified path.
Compiling Without Projects
If you would like to avoid working with Projects, you can use the
SearchCompiler class directly.
import search_compiler as sc compiler = sc.SearchCompiler() circuit, vector = compiler.compile(target_unitary)
SearchCompiler class and the
compile function can take extra arguments to further configure the compiler. The return values are, in order, the unitary that represents the implemented circuit, the
sc.QuantumStep representation of the circuit structure, and the vector of parameters for the circuit structure.
To export openqasm code, use the
assemble function from
myqasm = sc.assembler.assemble(circuit, vector, sc.assembler.ASSEMBLY_IBMOPENQASM) # to get output as a string sc.assembler.assemble(circuit, vector, sc.assembler.ASSEMBLY_IBMOPENQASM, write_location="myqasm.txt") # to write the output to a file
A Note On Endianness
We use the physics convention of using big endian when naming our qubits. Some quantum programs, including IBM's Qiskit, use little endian. This means you will need to reverse the endianness of a unitary designed for Qiskit in order to work with our code, or visa versa. We provide a function that performs endian reversal on numpy matrices:
little_endian = sc.utils.endian_reverse(big_endian) # you can use the same function to convert in the other direction as well
Find information on customizing the compiler in the wiki.
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
|Filename, size||File type||Python version||Upload date||Hashes|
|Filename, size search_compiler-1.2.1-py2.py3-none-any.whl (30.5 kB)||File type Wheel||Python version py2.py3||Upload date||Hashes View|
|Filename, size search_compiler-1.2.1.tar.gz (27.4 kB)||File type Source||Python version None||Upload date||Hashes View|
Hashes for search_compiler-1.2.1-py2.py3-none-any.whl