• GeneralARTIQ

  • What is the recommended way for users to add custom applets?

The applets window in the ARTIQ dashboard works well with applets saved in artiq.applets. In order to add custom applets in the dashboard, do the users need to create a fork of ARTIQ and add files under artiq.applets? I think another solution could be an argument (of artiq_dashboard?) linking to a folder that saves all the custom applets.

Expanding a bit on this question and https://forum.m-labs.hk/d/199-how-do-users-choose-folder-to-save-data-in, does ARTIQ encourage non-developer users to fork ARTIQ and make user-dependent changes or to use the vanilla ARTIQ (with documented options that allow users to do what they wish to do). It seems better to me to have options that expand upon the vanilla ARTIQ, so it would be easier to trace if a bug happens, and it would be easier to resolve conflicts if a user wants to update their ARTIQ to the latest versions.

    fanmingyu212 do the users need to create a fork of ARTIQ and add files under artiq.applets?

    No. You can use arbitrary shell commands to run an applet, which can obtain it from any directory. artiq.applets isn't a special location, it is used only in the built-in applet command templates.

    fanmingyu212 does ARTIQ encourage non-developer users to fork ARTIQ and make user-dependent changes

    No. Stock ARTIQ aims to be flexible/generic enough.

          sb10q You can use arbitrary shell commands to run an applet, which can obtain it from any directory.

          python -m applet_path.py command works, but I am wondering if/how we can add such applets not in artiq.applets to the Applets panel in the dashboard, so we can start/stop them easily?

            Just enter python -m applet_path.py ... in the applets panel.

              7 days later

              lriesebos thank you for sharing the code! The links you sent are very helpful. The CcbTool wrapper class seems to be what I was looking for.