M-Labs
/
artiq
mirror of https://github.com/m-labs/artiq.git
2
0
Fork 2
Code Issues Projects Releases Wiki Activity

doc: document artiq_coreanalyzer usage. (#1233)

This commit is contained in:
Drew 2019-01-10 00:01:36 -05:00 committed by Sébastien Bourdeauducq
parent 99a0f61b35
commit 58e872e7b5
2 changed files with 3 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
doc/manual/getting_started_core.rst
View File

@ -174,6 +174,7 @@ Within a parallel block, some statements can be made sequential again using a ``
self.ttl1.pulse(4*us) self.ttl1.pulse(4*us)
delay(4*us) delay(4*us)
.. _rtio-analyzer-example:
RTIO analyzer RTIO analyzer
------------- -------------

2
doc/manual/utilities.rst
View File

@ -172,6 +172,8 @@ You do not need to remove a record in order to change its value, just overwrite
Core device RTIO analyzer tool Core device RTIO analyzer tool
------------------------------ ------------------------------
:mod:`~artiq.frontend.artiq_coreanalyzer` is a tool to convert core device RTIO logs to VCD waveform files that are readable by third-party tools such as GtkWave. This tool extracts pre-recorded data from an ARTIQ core device buffer (or from a file with the ``-r`` option), and converts it to a standard VCD file format. See :ref:`rtio-analyzer-example` for an example, or :mod:`artiq.test.coredevice.test_analyzer` for a relevant unit test.
.. argparse:: .. argparse::
:ref: artiq.frontend.artiq_coreanalyzer.get_argparser :ref: artiq.frontend.artiq_coreanalyzer.get_argparser
:prog: artiq_coreanalyzer :prog: artiq_coreanalyzer