M-Labs
/
artiq
mirror of https://github.com/m-labs/artiq.git
2
0
Fork 2
Code Issues Projects Releases Wiki Activity

manual: list NDSPs and their packages

This commit is contained in:
Sebastien Bourdeauducq 2019-04-23 00:39:27 +08:00
parent be99496124
commit 5bef72dbd6
3 changed files with 36 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
doc/manual/index.rst
View File

@ -21,6 +21,7 @@ Contents:
core_language_reference core_language_reference
core_drivers_reference core_drivers_reference
protocols_reference protocols_reference
list_of_ndsps
developing_a_ndsp developing_a_ndsp
utilities utilities
default_network_ports default_network_ports

2
doc/manual/installing.rst
View File

@ -115,7 +115,7 @@ Download the `ARTIQ installer script <https://raw.githubusercontent.com/m-labs/a
.. note:: .. 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. 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: :: Make sure the base Conda environment is activated and then run the installer script: ::

34
doc/manual/list_of_ndsps.rst Normal file
View File

@ -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.