README.md

QOP

QOP¹ is a quantum variational optimizer simulator written in C, with a Python interface.

Getting Started

C

In order to build the current codebase, just clone the repository and run make all:

git clone [email protected]:MikeEVMM/qop.git
cd qop
make all

This will compile all the source (src/) and headers (include/) into objects under obj/, and link them into an executable (main.out).

You can then run the executable (with entry point at main.c:main()) by either explicitly calling

./main.out

or

make run

Running main isn't too interesting, so you might want to start by reading the header files, where all declarations are documented², and the source files function comments, if you're interested in the implementation details.

Python

You can also build and install the Python interface library (qop) by running

# Clone the library if you haven't done so already
# git clone https://[email protected]/MikeEVMM/qop.git
# cd qop
make py_build

This will install the library with the --user flag set; if you want to disable this flag, set the no_user variable:

no_user=y make py_build

Or if you don't want to install the library at all (in which case it can be found under build/), set the no_install variable:

no_install=y make py_build

License

This work is licensed under a Creative Commons Attribution NonCommercial (CC-BY-NC) license. See LICENSE.txt for the full license.

---

¹ pronounced qwop (kwɒp), like the game.

² the project attempts to follow Google's style guide.