From 5bef72dbd63d4ac6db6aee032d4a81b403819e07 Mon Sep 17 00:00:00 2001
From: Sebastien Bourdeauducq <sb@m-labs.hk>
Date: Tue, 23 Apr 2019 00:39:27 +0800
Subject: [PATCH] manual: list NDSPs and their packages

---
 doc/manual/index.rst         |  1 +
 doc/manual/installing.rst    |  2 +-
 doc/manual/list_of_ndsps.rst | 34 ++++++++++++++++++++++++++++++++++
 3 files changed, 36 insertions(+), 1 deletion(-)
 create mode 100644 doc/manual/list_of_ndsps.rst

diff --git a/doc/manual/index.rst b/doc/manual/index.rst
index 7daeb098b..3465bc0ac 100644
--- a/doc/manual/index.rst
+++ b/doc/manual/index.rst
@@ -21,6 +21,7 @@ Contents:
     core_language_reference
     core_drivers_reference
     protocols_reference
+    list_of_ndsps
     developing_a_ndsp
     utilities
     default_network_ports
diff --git a/doc/manual/installing.rst b/doc/manual/installing.rst
index 9f06a8f14..1f386e833 100644
--- a/doc/manual/installing.rst
+++ b/doc/manual/installing.rst
@@ -115,7 +115,7 @@ Download the `ARTIQ installer script <https://raw.githubusercontent.com/m-labs/a
 .. note::
   If you do not need to flash boards, the ``artiq`` package from the ``main`` Hydra build is sufficient. The packages named ``artiq-board-*`` contain only firmware for the FPGA board and are never necessary for using an ARTIQ system without reflashing it.
 
-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.
+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/project/artiq>`_ or see the list of NDSPs in this manual 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: ::
 
diff --git a/doc/manual/list_of_ndsps.rst b/doc/manual/list_of_ndsps.rst
new file mode 100644
index 000000000..a049eaea1
--- /dev/null
+++ b/doc/manual/list_of_ndsps.rst
@@ -0,0 +1,34 @@
+List of available NDSPs
+=======================
+
+The following network device support packages are available for ARTIQ. This list is non-exhaustive.
+
++---------------------------------+-----------------------------------+----------------------------------+
+| Equipment                       | Nix package                       | Conda package                    |
++=================================+===================================+==================================+
+| PDQ2                            | Not available                     | Not available                    |
++---------------------------------+-----------------------------------+----------------------------------+
+| Lab Brick Digital Attenuator    | ``m-labs.lda``                    | ``("main", "lda")``              |
++---------------------------------+-----------------------------------+----------------------------------+
+| Novatech 409B                   | ``m-labs.novatech409b``           | ``("main", "novatech409b")``     |
++---------------------------------+-----------------------------------+----------------------------------+
+| Thorlabs T-Cube                 | ``m-labs.thorlabs_tcube``         | ``("main", "thorlabs_tcube")``   |
++---------------------------------+-----------------------------------+----------------------------------+
+| Korad KA3005P                   | ``m-labs.korad_k3005p``           | ``("main", "korad_k3005p")``     |
++---------------------------------+-----------------------------------+----------------------------------+
+| Newfocus 8742                   | ``m-labs.newfocus8742``           | ``("main", "newfocus8742")``     |
++---------------------------------+-----------------------------------+----------------------------------+
+| Princeton Instruments PICam     | Not available                     | Not available                    |
++---------------------------------+-----------------------------------+----------------------------------+
+| Anel HUT2 power distribution    | ``m-labs.hut2``                   | ``("main", "hut2")``             |
++---------------------------------+-----------------------------------+----------------------------------+
+| TOPTICA Lasers                  | ``m-labs.toptica-lasersdk-artiq`` | See anaconda.org                 |
++---------------------------------+-----------------------------------+----------------------------------+
+| HighFinesse wavemeter           | ``m-labs.highfinesse-net``        | ``("main", "highfinessse-net")`` |
++---------------------------------+-----------------------------------+----------------------------------+
+
+In the "Nix package" column, ``m-labs`` refer to the Nix channel at https://nixbld.m-labs.hk/channel/custom/artiq/main/channel.
+
+The "Conda package" column gives the line to add into ``install-artiq.py`` to install the corresponding package. Conda packages may also be downloaded from https://nixbld.m-labs.hk/project/artiq and installed manually.
+
+For PDQ2 see https://github.com/m-labs/pdq. For PICam see https://github.com/quartiq/picam.