diff --git a/doc/manual/faq.rst b/doc/manual/faq.rst index bd5d4ac89..24c6d48e8 100644 --- a/doc/manual/faq.rst +++ b/doc/manual/faq.rst @@ -81,7 +81,7 @@ It will give you the ``/dev/ttyUSBxx`` (or the ``COMxx`` for Windows) device names. The ``hwid:`` field gives you the string you can pass via the ``hwgrep://`` feature of pyserial -`serial_for_url() `_ +`serial_for_url() `_ in order to open a serial device. The preferred way to specify a serial device is to make use of the ``hwgrep://`` diff --git a/doc/manual/installing.rst b/doc/manual/installing.rst index 7fcf8b1ef..86ef91f5f 100644 --- a/doc/manual/installing.rst +++ b/doc/manual/installing.rst @@ -14,7 +14,7 @@ In the current state of affairs, we recommend that Linux users install ARTIQ via Installing via Nix (Linux) -------------------------- -First, install the Nix package manager. Some distributions provide a package for the Nix package manager, otherwise, it can be installed via the script on the `Nix website `_. Make sure you get Nix version 2.4 or higher. +First, install the Nix package manager. Some distributions provide a package for the Nix package manager, otherwise, it can be installed via the script on the `Nix website `_. Make sure you get Nix version 2.4 or higher. Once Nix is installed, enable Flakes: :: @@ -100,7 +100,7 @@ Installing via Conda (Windows, Linux) .. warning:: For Linux users, the Nix package manager is preferred, as it is more reliable and faster than Conda. -First, install `Anaconda `_ or the more minimalistic `Miniconda `_. +First, install `Anaconda `_ or the more minimalistic `Miniconda `_. After installing either Anaconda or Miniconda, open a new terminal (also known as command line, console, or shell and denoted here as lines starting with ``$``) and verify the following command works:: diff --git a/doc/manual/list_of_ndsps.rst b/doc/manual/list_of_ndsps.rst index 12d698e20..a170ca210 100644 --- a/doc/manual/list_of_ndsps.rst +++ b/doc/manual/list_of_ndsps.rst @@ -3,28 +3,28 @@ List of available NDSPs The following network device support packages are available for ARTIQ. If you would like to add yours to this list, just send us an email or a pull request. -+---------------------------------+-----------------------------------+----------------------------------+-----------------------------------------------------------------------------------------------------+--------------------------------------------------------+ -| Equipment | Nix package | Conda package | Documentation | URL | -+=================================+===================================+==================================+=====================================================================================================+========================================================+ -| PDQ2 | Not available | Not available | `HTML `_ | https://github.com/m-labs/pdq | -+---------------------------------+-----------------------------------+----------------------------------+-----------------------------------------------------------------------------------------------------+--------------------------------------------------------+ -| Lab Brick Digital Attenuator | ``lda`` | ``lda`` | `HTML `_ | https://github.com/m-labs/lda | -+---------------------------------+-----------------------------------+----------------------------------+-----------------------------------------------------------------------------------------------------+--------------------------------------------------------+ -| Novatech 409B | ``novatech409b`` | ``novatech409b`` | `HTML `_ | https://github.com/m-labs/novatech409b | -+---------------------------------+-----------------------------------+----------------------------------+-----------------------------------------------------------------------------------------------------+--------------------------------------------------------+ -| Thorlabs T-Cubes | ``thorlabs_tcube`` | ``thorlabs_tcube`` | `HTML `_ | https://github.com/m-labs/thorlabs_tcube | -+---------------------------------+-----------------------------------+----------------------------------+-----------------------------------------------------------------------------------------------------+--------------------------------------------------------+ -| Korad KA3005P | ``korad_ka3005p`` | ``korad_ka3005p`` | `HTML `_ | https://github.com/m-labs/korad_ka3005p | -+---------------------------------+-----------------------------------+----------------------------------+-----------------------------------------------------------------------------------------------------+--------------------------------------------------------+ -| Newfocus 8742 | ``newfocus8742`` | ``newfocus8742`` | `HTML `_ | https://github.com/quartiq/newfocus8742 | -+---------------------------------+-----------------------------------+----------------------------------+-----------------------------------------------------------------------------------------------------+--------------------------------------------------------+ -| Princeton Instruments PICam | Not available | Not available | Not available | https://github.com/quartiq/picam | -+---------------------------------+-----------------------------------+----------------------------------+-----------------------------------------------------------------------------------------------------+--------------------------------------------------------+ -| Anel HUT2 power distribution | ``hut2`` | ``hut2`` | `HTML `_ | https://github.com/quartiq/hut2 | -+---------------------------------+-----------------------------------+----------------------------------+-----------------------------------------------------------------------------------------------------+--------------------------------------------------------+ -| TOPTICA lasers | ``toptica-lasersdk-artiq`` | ``toptica-lasersdk-artiq`` | Not available | https://github.com/quartiq/lasersdk-artiq | -+---------------------------------+-----------------------------------+----------------------------------+-----------------------------------------------------------------------------------------------------+--------------------------------------------------------+ -| HighFinesse wavemeters | ``highfinesse-net`` | ``highfinesse-net`` | `HTML `_ | https://github.com/quartiq/highfinesse-net | -+---------------------------------+-----------------------------------+----------------------------------+-----------------------------------------------------------------------------------------------------+--------------------------------------------------------+ -| InfluxDB database | Not available | Not available | `HTML `_ | https://gitlab.com/charlesbaynham/artiq_influx_generic | -+---------------------------------+-----------------------------------+----------------------------------+-----------------------------------------------------------------------------------------------------+--------------------------------------------------------+ ++---------------------------------+-----------------------------------+----------------------------------+------------------------------------------------------------------+--------------------------------------------------------+ +| Equipment | Nix package | Conda package | Documentation | URL | ++=================================+===================================+==================================+==================================================================+========================================================+ +| PDQ2 | Not available | Not available | `HTML `_ | https://github.com/m-labs/pdq | ++---------------------------------+-----------------------------------+----------------------------------+------------------------------------------------------------------+--------------------------------------------------------+ +| Lab Brick Digital Attenuator | ``lda`` | ``lda`` | Not available | https://github.com/m-labs/lda | ++---------------------------------+-----------------------------------+----------------------------------+------------------------------------------------------------------+--------------------------------------------------------+ +| Novatech 409B | ``novatech409b`` | ``novatech409b`` | Not available | https://github.com/m-labs/novatech409b | ++---------------------------------+-----------------------------------+----------------------------------+------------------------------------------------------------------+--------------------------------------------------------+ +| Thorlabs T-Cubes | ``thorlabs_tcube`` | ``thorlabs_tcube`` | Not available | https://github.com/m-labs/thorlabs_tcube | ++---------------------------------+-----------------------------------+----------------------------------+------------------------------------------------------------------+--------------------------------------------------------+ +| Korad KA3005P | ``korad_ka3005p`` | ``korad_ka3005p`` | Not available | https://github.com/m-labs/korad_ka3005p | ++---------------------------------+-----------------------------------+----------------------------------+------------------------------------------------------------------+--------------------------------------------------------+ +| Newfocus 8742 | ``newfocus8742`` | ``newfocus8742`` | Not available | https://github.com/quartiq/newfocus8742 | ++---------------------------------+-----------------------------------+----------------------------------+------------------------------------------------------------------+--------------------------------------------------------+ +| Princeton Instruments PICam | Not available | Not available | Not available | https://github.com/quartiq/picam | ++---------------------------------+-----------------------------------+----------------------------------+------------------------------------------------------------------+--------------------------------------------------------+ +| Anel HUT2 power distribution | ``hut2`` | ``hut2`` | Not available | https://github.com/quartiq/hut2 | ++---------------------------------+-----------------------------------+----------------------------------+------------------------------------------------------------------+--------------------------------------------------------+ +| TOPTICA lasers | ``toptica-lasersdk-artiq`` | ``toptica-lasersdk-artiq`` | Not available | https://github.com/quartiq/lasersdk-artiq | ++---------------------------------+-----------------------------------+----------------------------------+------------------------------------------------------------------+--------------------------------------------------------+ +| HighFinesse wavemeters | ``highfinesse-net`` | ``highfinesse-net`` | Not available | https://github.com/quartiq/highfinesse-net | ++---------------------------------+-----------------------------------+----------------------------------+------------------------------------------------------------------+--------------------------------------------------------+ +| InfluxDB database | Not available | Not available | `HTML `_ | https://gitlab.com/charlesbaynham/artiq_influx_generic | ++---------------------------------+-----------------------------------+----------------------------------+------------------------------------------------------------------+--------------------------------------------------------+