Skip to content

Latest commit

 

History

History
149 lines (97 loc) · 5.01 KB

utilities.rst

File metadata and controls

149 lines (97 loc) · 5.01 KB
Raw

Utilities

Local running tool

.. argparse::
   :ref: artiq.frontend.artiq_run.get_argparser
   :prog: artiq_run

Remote Procedure Call tool

.. argparse::
   :ref: artiq.frontend.artiq_rpctool.get_argparser
   :prog: artiq_rpctool

This tool is the preferred way of handling simple ARTIQ controllers. Instead of writing a client for very simple cases you can just use this tool in order to call remote functions of an ARTIQ controller.

  • Listing existing targets

    The list-targets sub-command will print to standard output the target list of the remote server:

    $ artiq_rpctool.py hostname port list-targets

  • Listing callable functions

    The list-methods sub-command will print to standard output a sorted list of the functions you can call on the remote server's target.

    The list will contain function names, signatures (arguments) and docstrings.

    If the server has only one target, you can do:

    $ artiq_rpctool.py hostname port list-methods

    Otherwise you need to specify the target, using the -t target option:

    $ artiq_rpctool.py hostname port list-methods -t target_name

  • Remotely calling a function

    The call sub-command will call a function on the specified remote server's target, passing the specified arguments. Like with the previous sub-command, you only need to provide the target name (with -t target) if the server hosts several targets.

    The following example will call the set_attenuation method of the Lda controller with the argument 5:

    $ artiq_rpctool.py ::1 3253 call -t lda set_attenuation 5

    In general, to call a function named f with N arguments named respectively x1, x2, ..., xN you can do:

    $ artiq_rpctool.py hostname port call -t target f x1 x2 ... xN

    You can use Python syntax to compute arguments as they will be passed to the eval() primitive. The numpy package is available in the namespace as np. Beware to use quotes to separate arguments which use spaces:

    $ artiq_rpctool.py hostname port call -t target f '3 * 4 + 2' True '[1, 2]'
$ artiq_rpctool.py ::1 3256 call load_sample_values 'np.array([1.0, 2.0], dtype=float)'

    If the called function has a return value, it will get printed to the standard output if the value is not None like in the standard python interactive console:

    $ artiq_rpctool.py ::1 3253 call get_attenuation
5.0 dB

Static compiler

This tool compiles an experiment into a ELF file. It is primarily used to prepare binaries for the default experiment loaded in non-volatile storage of the core device. Experiments compiled with this tool are not allowed to use RPCs, and their run entry point must be a kernel.

.. argparse::
   :ref: artiq.frontend.artiq_compile.get_argparser
   :prog: artiq_compile

Flash storage image generator

This tool compiles key/value pairs into a binary image suitable for flashing into the flash storage space of the core device.

.. argparse::
   :ref: artiq.frontend.artiq_mkfs.get_argparser
   :prog: artiq_mkfs

Core device configuration tool

The artiq_coreconfig tool allows to read, write and remove key-value records from the :ref:`core-device-flash-storage`.

It also allows to erase the entire flash storage area.

To use this tool, you need to specify a ddb.pyon DDB file which contains a comm device (an example is provided in artiq/examples/master/ddb.pyon). This tells the tool how to connect to the core device (via serial or via TCP) and with which parameters (baudrate, serial device, IP address, TCP port). When not specified, the artiq_coreconfig tool will assume that there is a file named ddb.pyon in the current directory.

To read the record whose key is mac:

$ artiq_coreconfig -r mac

To write the value test_value in the key my_key:

$ artiq_coreconfig -w my_key test_value
$ artiq_coreconfig -r my_key
b'test_value'

You can also write entire files in a record using the -f parameter:

$ echo "this_is_a_test" > my_filename
$ artiq_coreconfig -f my_key my_filename
$ artiq_coreconfig -r my_key
b'this_is_a_test\n'

You can write several records at once:

$ artiq_coreconfig -w key1 value1 -f key2 filename -w key3 value3

To remove the previously written key my_key:

$ artiq_coreconfig -d my_key

To erase the entire flash storage area:

$ artiq_coreconfig -e

You don't need to remove a record in order to change its value, just overwrite it:

$ artiq_coreconfig -w my_key some_value
$ artiq_coreconfig -w my_key some_other_value
$ artiq_coreconfig -r my_key
b'some_other_value'

.. argparse::
   :ref: artiq.frontend.artiq_coreconfig.get_argparser
   :prog: artiq_coreconfig