diff --git a/RELEASE_NOTES.rst b/RELEASE_NOTES.rst index abbc6d44f..6ffbb4bf0 100644 --- a/RELEASE_NOTES.rst +++ b/RELEASE_NOTES.rst @@ -28,6 +28,7 @@ ARTIQ-5 * The meaning of the ``-d/--dir`` and ``--srcbuild`` options of ``artiq_flash`` has changed. * Experiments can now programatically set their default pipeline, priority, and flush flag. +* Controllers for third-party devices are now out-of-tree. ARTIQ-4 diff --git a/conda/install-artiq.py b/conda/install-artiq.py index b17f3658c..4bdf26df3 100644 --- a/conda/install-artiq.py +++ b/conda/install-artiq.py @@ -8,7 +8,7 @@ CONDA_ENV_NAME = "artiq" # The conda packages to download from hydra and install. # 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 CONDA_PACKAGES = [ ("main", "artiq"), diff --git a/doc/manual/default_network_ports.rst b/doc/manual/default_network_ports.rst index 33fa74a05..3026d6cde 100644 --- a/doc/manual/default_network_ports.rst +++ b/doc/manual/default_network_ports.rst @@ -28,13 +28,13 @@ Default network ports +---------------------------------+--------------+ | 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 | +---------------------------------+--------------+ diff --git a/doc/manual/index.rst b/doc/manual/index.rst index 5d3fcdd98..7daeb098b 100644 --- a/doc/manual/index.rst +++ b/doc/manual/index.rst @@ -21,7 +21,6 @@ Contents: core_language_reference core_drivers_reference protocols_reference - ndsp_reference developing_a_ndsp utilities default_network_ports diff --git a/doc/manual/installing.rst b/doc/manual/installing.rst index 6c3e01215..31c2f6540 100644 --- a/doc/manual/installing.rst +++ b/doc/manual/installing.rst @@ -108,6 +108,8 @@ Executing just ``conda`` should print the help of the ``conda`` command. If your Download the `ARTIQ installer script `_ 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 `_ 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: :: $ conda activate base diff --git a/doc/manual/ndsp_reference.rst b/doc/manual/ndsp_reference.rst deleted file mode 100644 index 2a8f2b26e..000000000 --- a/doc/manual/ndsp_reference.rst +++ /dev/null @@ -1,9 +0,0 @@ -Network device support packages reference -========================================= - -Core device logging controller ------------------------------- - -.. argparse:: - :ref: artiq.frontend.aqctl_corelog.get_argparser - :prog: aqctl_corelog diff --git a/doc/manual/utilities.rst b/doc/manual/utilities.rst index 6bb712f78..c4ada76ad 100644 --- a/doc/manual/utilities.rst +++ b/doc/manual/utilities.rst @@ -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 :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