Using Plugins with GUI#

Plug-in Manager#

../_images/gui_plugin_manager.png

Plugin configuration for the GUI is primarily done through the ‘Plug-in Manager’ dialog. With the GUI running, navigate to Help > Manage plug-ins in the toolbar to open the ‘Plug-in Manager’.

../_images/gui_manage_plugins.png

Configuring Plugins for the GUI#

After a plugin is installed, it needs to be ‘configured’ via Plug-in Manager before it can be used by the GUI.

Plugin configurations persist between GUI sessions, so the following steps are only necessary once, and not needed on subsequent uses of the GUI.

  • Open the Plug-in Manager

  • If your plugin does not appear in the list, you will need to add it via one of these options:

    • If your plugin is preinstalled or installed via package manager, go to GUI - Select.

    • If your plugin is manually installed, go to GUI - Browse

    • If your plugin is hosted online, go to GUI - Web

Select#

With the Plug-in Manager dialog open, click the ‘Select’ button.

../_images/gui_plugin_manager_select_button.png

Find your plugin in the list that opens, then click ‘OK’.

../_images/gui_plugin_manager_select.png

Browse#

With the Plug-in Manager dialog open, click the ‘Browse’ button.

../_images/gui_plugin_manager_browse_button.png

Navigate to and select your plugin entry point (an individual script or __init__.py) and click ‘Open’.

../_images/gui_plugin_manager_browse.png

Web#

With the Plug-in Manager dialog open, click the ‘On Web’ button.

../_images/gui_plugin_manager_web_button.png

Provide a URL to load your plugin from, then click ‘OK’.

../_images/gui_plugin_manager_web.png

Enabling/Disabling Plugins for the GUI#

Plugins are ‘enabled’ for the GUI by default when they are initially configured. To enable/disable a plugin, open Plug-in Manager and click on the plugin row, then click the ‘Enable’ or ‘Disable’ button.