diff --git a/doc/manual/developing_a_ndsp.rst b/doc/manual/developing_a_ndsp.rst index 18e3a995a..be8809c58 100644 --- a/doc/manual/developing_a_ndsp.rst +++ b/doc/manual/developing_a_ndsp.rst @@ -186,3 +186,8 @@ General guidelines * Keep command line parameters consistent across clients/controllers. When adding new command line options, look for a client/controller that does a similar thing and follow its use of ``argparse``. If the original client/controller could use ``argparse`` in a better way, improve it. * Use docstrings for all public methods of the driver (note that those will be retrieved by ``sipyco_rpctool``). * Choose a free default TCP port and add it to the default port list in this manual. + +Hosting your code +----------------- + +We suggest that you create a Git repository for your code, and publish it on https://git.m-labs.hk/, GitLab, GitHub, or a similar website of your choosing. Then send us a message or pull request for your NDSP to be added to the list in this manual. diff --git a/doc/manual/list_of_ndsps.rst b/doc/manual/list_of_ndsps.rst index a8c4c06b3..74237b22a 100644 --- a/doc/manual/list_of_ndsps.rst +++ b/doc/manual/list_of_ndsps.rst @@ -1,30 +1,28 @@ List of available NDSPs ======================= -The following network device support packages are available for ARTIQ. This list is non-exhaustive. +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 | -+=================================+===================================+==================================+=====================================================================================================+ -| PDQ2 | Not available | Not available | `HTML `_ | -+---------------------------------+-----------------------------------+----------------------------------+-----------------------------------------------------------------------------------------------------+ -| Lab Brick Digital Attenuator | ``lda`` | ``lda`` | `HTML `_ | -+---------------------------------+-----------------------------------+----------------------------------+-----------------------------------------------------------------------------------------------------+ -| Novatech 409B | ``novatech409b`` | ``novatech409b`` | `HTML `_ | -+---------------------------------+-----------------------------------+----------------------------------+-----------------------------------------------------------------------------------------------------+ -| Thorlabs T-Cubes | ``thorlabs_tcube`` | ``thorlabs_tcube`` | `HTML `_ | -+---------------------------------+-----------------------------------+----------------------------------+-----------------------------------------------------------------------------------------------------+ -| Korad KA3005P | ``korad_ka3005p`` | ``korad_ka3005p`` | `HTML `_ | -+---------------------------------+-----------------------------------+----------------------------------+-----------------------------------------------------------------------------------------------------+ -| Newfocus 8742 | ``newfocus8742`` | ``newfocus8742`` | `HTML `_ | -+---------------------------------+-----------------------------------+----------------------------------+-----------------------------------------------------------------------------------------------------+ -| Princeton Instruments PICam | Not available | Not available | Not available | -+---------------------------------+-----------------------------------+----------------------------------+-----------------------------------------------------------------------------------------------------+ -| Anel HUT2 power distribution | ``hut2`` | ``hut2`` | `HTML `_ | -+---------------------------------+-----------------------------------+----------------------------------+-----------------------------------------------------------------------------------------------------+ -| TOPTICA lasers | ``toptica-lasersdk-artiq`` | ``toptica-lasersdk-artiq`` | Not available | -+---------------------------------+-----------------------------------+----------------------------------+-----------------------------------------------------------------------------------------------------+ -| HighFinesse wavemeters | ``highfinesse-net`` | ``highfinesse-net`` | `HTML `_ | -+---------------------------------+-----------------------------------+----------------------------------+-----------------------------------------------------------------------------------------------------+ - -For PDQ2 see https://github.com/m-labs/pdq. For PICam see https://github.com/quartiq/picam. ++---------------------------------+-----------------------------------+----------------------------------+-----------------------------------------------------------------------------------------------------+----------------------------------------------+ +| 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 | ++---------------------------------+-----------------------------------+----------------------------------+-----------------------------------------------------------------------------------------------------+----------------------------------------------+