Build Status

The asynchronous RPC client-server framework and message specification for Rigetti Quantum Cloud Services (QCS).

Implements an efficient transport protocol by using ZeroMQ (ZMQ) sockets and MessagePack (msgpack) serialization.

Not intended to be a full-featured replacement for other frameworks like gRPC or Apache Thrift.


To install directly from the source, run pip install -e . from within the top-level directory of the rpcq repository. To additionally install the requirements for testing, make sure to run pip install -r requirements.txt.

To instead install the latest released verson of rpcq from the Python package manager PyPi, run pip install rpcq.

NOTE: We strongly encourage users of rpcq to install the software within a (Python) virtual environment (read up on virtualenv, pyenv, or conda for more info).

Using the Client-Server Framework

First, create a server, add a test handler, and spin it up.

from rpcq import Server

server = Server()

def test():
    return 'test'


In another window, create a client that points to the same socket, and call the test method.

from rpcq import Client

client = Client('tcp://localhost:5555')


This will return the string 'test'.

Using the Message Spec

The message spec as defined in src/messages.lisp (which in turn produces rpcq/messages.py) is meant to be used with the Rigetti QCS platform. Therefore, these messages are used in pyquil, in order to allow users to communicate with the Rigetti Quil compiler and quantum processing units (QPUs). PyQuil provides utilities for users to interact with the QCS API and write programs in Quil, the quantum instruction language developed at Rigetti.

Thus, most users will not interact with rpcq.messages directly. However, for those interested in building their own implementation of the QCS API utilities in pyQuil, becoming acquainted with the client-server framework, the available messages in the message spec, and how they are used in the pyquil.api module would be a good place to start!

Updating the Python Message Bindings

Currently only Python bindings are available for the message spec, but more language bindings are in the works. To update the Python message bindings after editing src/messages.lisp, open rlwrap sbcl and run:

(ql:quickload :rpcq)
(with-open-file (f "rpcq/messages.py" :direction :output :if-exists :supersede)
  (rpcq:python-message-spec f))

NOTE: Requires pre-installed sbcl, quicklisp, and (optionally) rlwrap.

Running the Unit Tests

The rpcq repository is configured with SemaphoreCI to automatically run the Python unit tests. This can be done locally by running pytest from the top-level directory of the repository (assuming you have installed the test requirements).

There is additionally a very small suite of Lisp tests for rpcq. These are not run by SemaphoreCI, but can be run locally by doing the following from within rlwrap sbcl:

(ql:quickload :rpcq)
(asdf:test-system :rpcq)

There may be some instances of SYTLE-WARNING, but if the test run successfully, there should be something near the bottom of the output that looks like:

  TEST-DEFMESSAGE                                                         [ OK ]


Developed at Rigetti Computing by Nikolas Tezak, Steven Heidel, Peter Karalekas, Eric Peterson, and Robert Smith.

Rigetti Computing <info@rigetti.com>