From 122ddc40aab6f80dc2773ec27bfd22e9c0be5898 Mon Sep 17 00:00:00 2001 From: Sebastien Bourdeauducq Date: Mon, 15 Feb 2016 23:07:41 +0100 Subject: [PATCH] doc: add section for RTIO analyzer, mention GtkWave --- doc/manual/getting_started_core.rst | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/doc/manual/getting_started_core.rst b/doc/manual/getting_started_core.rst index 334656869..0ab8f2bc6 100644 --- a/doc/manual/getting_started_core.rst +++ b/doc/manual/getting_started_core.rst @@ -134,6 +134,9 @@ Try reducing the period of the generated waveform until the CPU cannot keep up w except RTIOUnderflow: print_underflow() +RTIO analyzer +------------- + The core device records the real-time IO waveforms into a circular buffer. It is possible to dump any Python object so that it appears alongside the waveforms using the ``rtio_log`` function, which accepts a channel name (i.e. a log target) as the first argument: :: from artiq.experiment import * @@ -151,7 +154,7 @@ The core device records the real-time IO waveforms into a circular buffer. It is rtio_log("ttl0", "i", i) delay(...) -Afterwards, the recorded data can be extracted and written to a VCD file using ``artiq_coreanalyzer -w rtio.vcd`` (see: :ref:`core-device-rtio-analyzer-tool`). +Afterwards, the recorded data can be extracted and written to a VCD file using ``artiq_coreanalyzer -w rtio.vcd`` (see: :ref:`core-device-rtio-analyzer-tool`). VCD files can be viewed using third-party tools such as GtkWave. Parallel and sequential blocks ------------------------------