qick.pyro

Functions

make_proxy(ns_host[, ns_port, proxy_name, ...])

Connects to a QickSoc proxy server.

start_nameserver([ns_host, ns_port])

Starts a Pyro4 nameserver.

start_server(ns_host[, ns_port, proxy_name, ...])

Initializes the QickSoc and starts a Pyro4 proxy server.

qick.pyro.start_nameserver(ns_host='0.0.0.0', ns_port=8888)[source]

Starts a Pyro4 nameserver.

Parameters:
  • ns_host (str) – the nameserver hostname

  • ns_port (int) – the port number for the nameserver to listen on

qick.pyro.start_server(ns_host, ns_port=8888, proxy_name='myqick', soc_class=<class 'qick.qick.QickSoc'>, iface='eth0', **kwargs)[source]

Initializes the QickSoc and starts a Pyro4 proxy server.

Parameters:
  • ns_host (str) – hostname or IP address of the nameserver if the nameserver is running on the QICK board, “localhost” is fine

  • ns_port (int) – the port number you used when starting the nameserver

  • proxy_name (str) – name for the QickSoc proxy multiple boards can use the same nameserver, but must have different names

  • soc_class (class) – class to proxy, if you want to use a class other than QickSoc (e.g. if you need to use RFQickSoc)

  • iface (str) – network interface whose address will be advertised - this should be the interface you expect to make Pyro connections on

  • kwargs (optional named arguments) – any other options will be passed to the QickSoc constructor; see QickSoc documentation for details

qick.pyro.make_proxy(ns_host, ns_port=8888, proxy_name='myqick', remote_traceback=True)[source]

Connects to a QickSoc proxy server.

Parameters:
  • ns_host (str) – hostname or IP address of the nameserver if the nameserver is running on the same PC you are running make_proxy() on, “localhost” is fine

  • ns_port (int) – the port number you used when starting the nameserver

  • proxy_name (str) – name for the QickSoc proxy you used when running start_server()

  • remote_traceback (bool) – if running in IPython (Jupyter etc.), reconfigure the IPython exception handler to print the remote Pyro traceback

Returns:

  • Proxy – proxy to QickSoc - this is usually called “soc” in demos

  • QickConfig – config object - this is usually called “soccfg” in demos