forked from M-Labs/artiq
update documentation after moving controllers out-of-tree (#887)
This commit is contained in:
parent
deffb77a7e
commit
2ada5227f0
|
@ -28,6 +28,7 @@ ARTIQ-5
|
||||||
* The meaning of the ``-d/--dir`` and ``--srcbuild`` options of ``artiq_flash``
|
* The meaning of the ``-d/--dir`` and ``--srcbuild`` options of ``artiq_flash``
|
||||||
has changed.
|
has changed.
|
||||||
* Experiments can now programatically set their default pipeline, priority, and flush flag.
|
* Experiments can now programatically set their default pipeline, priority, and flush flag.
|
||||||
|
* Controllers for third-party devices are now out-of-tree.
|
||||||
|
|
||||||
|
|
||||||
ARTIQ-4
|
ARTIQ-4
|
||||||
|
|
|
@ -8,7 +8,7 @@
|
||||||
CONDA_ENV_NAME = "artiq"
|
CONDA_ENV_NAME = "artiq"
|
||||||
# The conda packages to download from hydra and install.
|
# The conda packages to download from hydra and install.
|
||||||
# Each entry is ("hydra build name", "conda package name"). Hydra builds are:
|
# Each entry is ("hydra build name", "conda package name"). Hydra builds are:
|
||||||
# * main: core ARTIQ packages
|
# * main: core ARTIQ packages, including controllers for third-party devices
|
||||||
# * sinara-systems: firmware and gateware builds for generic Sinara systems
|
# * sinara-systems: firmware and gateware builds for generic Sinara systems
|
||||||
CONDA_PACKAGES = [
|
CONDA_PACKAGES = [
|
||||||
("main", "artiq"),
|
("main", "artiq"),
|
||||||
|
|
|
@ -28,13 +28,13 @@ Default network ports
|
||||||
+---------------------------------+--------------+
|
+---------------------------------+--------------+
|
||||||
| PDQ2 (out-of-tree) | 3252 |
|
| PDQ2 (out-of-tree) | 3252 |
|
||||||
+---------------------------------+--------------+
|
+---------------------------------+--------------+
|
||||||
| LDA | 3253 |
|
| LDA (out-of-tree) | 3253 |
|
||||||
+---------------------------------+--------------+
|
+---------------------------------+--------------+
|
||||||
| Novatech 409B | 3254 |
|
| Novatech 409B (out-of-tree) | 3254 |
|
||||||
+---------------------------------+--------------+
|
+---------------------------------+--------------+
|
||||||
| Thorlabs T-Cube | 3255 |
|
| Thorlabs T-Cube (out-of-tree) | 3255 |
|
||||||
+---------------------------------+--------------+
|
+---------------------------------+--------------+
|
||||||
| Korad KA3005P | 3256 |
|
| Korad KA3005P (out-of-tree) | 3256 |
|
||||||
+---------------------------------+--------------+
|
+---------------------------------+--------------+
|
||||||
| Newfocus 8742 (out-of-tree) | 3257 |
|
| Newfocus 8742 (out-of-tree) | 3257 |
|
||||||
+---------------------------------+--------------+
|
+---------------------------------+--------------+
|
||||||
|
|
|
@ -21,7 +21,6 @@ Contents:
|
||||||
core_language_reference
|
core_language_reference
|
||||||
core_drivers_reference
|
core_drivers_reference
|
||||||
protocols_reference
|
protocols_reference
|
||||||
ndsp_reference
|
|
||||||
developing_a_ndsp
|
developing_a_ndsp
|
||||||
utilities
|
utilities
|
||||||
default_network_ports
|
default_network_ports
|
||||||
|
|
|
@ -108,6 +108,8 @@ Executing just ``conda`` should print the help of the ``conda`` command. If your
|
||||||
|
|
||||||
Download the `ARTIQ installer script <https://raw.githubusercontent.com/m-labs/artiq/master/conda/install-artiq.py>`_ and edit its beginning to define the Conda environment name (you can leave the default environment name if you are just getting started) and select the desired ARTIQ packages. Non-ARTIQ packages should be installed manually later. If you do not need to flash boards, the ``artiq`` package from the ``main`` Hydra build is sufficient.
|
Download the `ARTIQ installer script <https://raw.githubusercontent.com/m-labs/artiq/master/conda/install-artiq.py>`_ and edit its beginning to define the Conda environment name (you can leave the default environment name if you are just getting started) and select the desired ARTIQ packages. Non-ARTIQ packages should be installed manually later. If you do not need to flash boards, the ``artiq`` package from the ``main`` Hydra build is sufficient.
|
||||||
|
|
||||||
|
Controllers for third-party devices (e.g. Thorlabs TCube, Lab Brick Digital Attenuator, etc.) that are not shipped with ARTIQ can also be installed with this script. Browse `Hydra <https://nixbld.m-labs.hk/>`_ to find the names of the corresponding packages, and list them at the beginning of the script.
|
||||||
|
|
||||||
Make sure the base Conda environment is activated and then run the installer script: ::
|
Make sure the base Conda environment is activated and then run the installer script: ::
|
||||||
|
|
||||||
$ conda activate base
|
$ conda activate base
|
||||||
|
|
|
@ -1,9 +0,0 @@
|
||||||
Network device support packages reference
|
|
||||||
=========================================
|
|
||||||
|
|
||||||
Core device logging controller
|
|
||||||
------------------------------
|
|
||||||
|
|
||||||
.. argparse::
|
|
||||||
:ref: artiq.frontend.aqctl_corelog.get_argparser
|
|
||||||
:prog: aqctl_corelog
|
|
|
@ -167,6 +167,13 @@ You do not need to remove a record in order to change its value, just overwrite
|
||||||
:ref: artiq.frontend.artiq_coremgmt.get_argparser
|
:ref: artiq.frontend.artiq_coremgmt.get_argparser
|
||||||
:prog: artiq_coremgmt
|
:prog: artiq_coremgmt
|
||||||
|
|
||||||
|
Core device logging controller
|
||||||
|
------------------------------
|
||||||
|
|
||||||
|
.. argparse::
|
||||||
|
:ref: artiq.frontend.aqctl_corelog.get_argparser
|
||||||
|
:prog: aqctl_corelog
|
||||||
|
|
||||||
.. _core-device-rtio-analyzer-tool:
|
.. _core-device-rtio-analyzer-tool:
|
||||||
|
|
||||||
Core device RTIO analyzer tool
|
Core device RTIO analyzer tool
|
||||||
|
|
Loading…
Reference in New Issue