From 4509ad86f8c7156e4e2aed6ca4833839cb3f7a55 Mon Sep 17 00:00:00 2001 From: architeuthis Date: Wed, 5 Jun 2024 17:08:12 +0800 Subject: [PATCH] Remove outdated references to examples/master, fix labels --- doc/manual/core_device.rst | 4 ++-- doc/manual/getting_started_mgmt.rst | 2 +- doc/manual/installing.rst | 7 +++++-- doc/manual/rtio.rst | 2 ++ doc/manual/utilities.rst | 3 +-- 5 files changed, 11 insertions(+), 7 deletions(-) diff --git a/doc/manual/core_device.rst b/doc/manual/core_device.rst index 8949836e2..470935aef 100644 --- a/doc/manual/core_device.rst +++ b/doc/manual/core_device.rst @@ -5,7 +5,6 @@ The core device is a FPGA-based hardware component that contains a softcore or h While it is possible to use all the other parts of ARTIQ (controllers, master, GUI, dataset management, etc.) without a core device, many experiments require it. - .. _core-device-flash-storage: Flash storage @@ -13,7 +12,7 @@ Flash storage The core device contains some flash storage space which is largely used to store configuration data. It is one sector (typically 64 kB) large and organized as a list of key-value records, accessible by using ``artiq_coremgmt`` (see: :ref:`core-device-management-tool`). -This area is used to store a variety of configurations, in particular the core device IP address and, if present, the startup and/or idle kernels (see also: :ref:`miscellaneous-configuration-of-the-core-device`). +This area is used to store a variety of configurations, in particular the core device IP address and, if present, the startup and/or idle kernels (see also: :ref:`miscellaneous_config_core_device`). .. _board-ports: @@ -158,6 +157,7 @@ To avoid I/O contention, the startup kernel should first program the TCA6424A ex See :mod:`artiq.coredevice.i2c` for more details. .. _core-device-clocking: + Clocking ++++++++ diff --git a/doc/manual/getting_started_mgmt.rst b/doc/manual/getting_started_mgmt.rst index e9398c7bc..334d6389c 100644 --- a/doc/manual/getting_started_mgmt.rst +++ b/doc/manual/getting_started_mgmt.rst @@ -10,7 +10,7 @@ Starting your first experiment with the master In the previous tutorial, we used the ``artiq_run`` utility to execute our experiments, which is a simple stand-alone tool that bypasses the ARTIQ management system. We will now see how to run an experiment using the master (the central program in the management system that schedules and executes experiments) and the dashboard (that connects to the master and controls it). -First, create a folder ``~/artiq-master`` and copy the file ``device_db.py`` (containing the device database) found in the ``examples/master`` directory from the ARTIQ sources. The master uses those files in the same way as ``artiq_run``. +First, create a folder ``~/artiq-master`` and copy your ``device_db.py`` into it (the file containing the device database, as described in :ref:`connecting-to-the-core-device`).The master uses those files in the same way as ``artiq_run``. Then create a ``~/artiq-master/repository`` sub-folder to contain experiments. The master scans this ``repository`` folder to determine what experiments are available (the name of the folder can be changed using ``-r``). diff --git a/doc/manual/installing.rst b/doc/manual/installing.rst index 8ae5b23cc..dfbaeccf8 100644 --- a/doc/manual/installing.rst +++ b/doc/manual/installing.rst @@ -243,8 +243,9 @@ You can list the environments you have created using:: $ conda env list .. _reflashing-core-device: + Reflashing core device gateware and firmware -------------------------------------------- +-------------------------------------------- .. note:: If you have purchased a pre-assembled system from M-Labs or QUARTIQ, the gateware and firmware of your device will already be flashed to the newest version of ARTIQ. These steps are only necessary if you obtained your hardware in a different way, or if you want to change or upgrade your ARTIQ version after purchase. @@ -374,6 +375,8 @@ Check that you can ping the device. If ping fails, check that the Ethernet link Regarding use of IPv6, note that the device also has a link-local address that corresponds to its EUI-64, which can be used simultaneously to the IPv6 address defined by using the ``ip6`` configuration key, which may be of arbitrary nature. +.. _miscellaneous_config_core_device: + Miscellaneous configuration of the core device ---------------------------------------------- @@ -422,7 +425,7 @@ Other options include: Availability of these options depends on specific board and configuration - specific settings may or may not be supported. See also :ref:`core-device-clocking`. Set up resolving RTIO channels to their names -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ This feature allows you to print the channels' respective names alongside with their numbers in RTIO error messages. To enable it, run the ``artiq_rtiomap`` tool and write its result into the device config at the ``device_map`` key: :: diff --git a/doc/manual/rtio.rst b/doc/manual/rtio.rst index f5901ab0d..6db6bbbf7 100644 --- a/doc/manual/rtio.rst +++ b/doc/manual/rtio.rst @@ -1,3 +1,5 @@ +.. _artiq-real-time-i-o-concepts: + ARTIQ Real-Time I/O Concepts ============================ diff --git a/doc/manual/utilities.rst b/doc/manual/utilities.rst index 248e1b88a..14dd2eb87 100644 --- a/doc/manual/utilities.rst +++ b/doc/manual/utilities.rst @@ -12,7 +12,6 @@ Local running tool :ref: artiq.frontend.artiq_run.get_argparser :prog: artiq_run - Static compiler --------------- @@ -48,7 +47,7 @@ Core device management tool The artiq_coremgmt utility gives remote access to the core device logs, the :ref:`core-device-flash-storage`, and other management functions. -To use this tool, you need to specify a ``device_db.py`` device database file which contains a ``comm`` device (an example is provided in ``examples/master/device_db.py``). This tells the tool how to connect to the core device and with which parameters (e.g. IP address, TCP port). When not specified, the artiq_coremgmt utility will assume that there is a file named ``device_db.py`` in the current directory. +To use this tool, it is necessary to specify the IP address your core device can be contacted at. If no option is used, the utility will assume there is a file named ``device_db.py`` in the current directory containing the device database; otherwise, a device database file can be provided with ``--device-db`` or an address directly with ``--device`` (see also below). To read core device logs::