Plugin Manager

---

PLUGIN MANAGER

---

This page aims to introduce you to the usage of Scipion Plugin Manager which is a friendly application to manage everything related to the installation of the Scipion plugins.

After running Scipion software from the command line, the projects manager is displayed and we select from Configuration menu the Plugins option (Figure 1).

Figure 1. Scipion project manager

Plugin Manager

After Plugins option is selected, the Plugin Manager interface is shown (Figure 2).

Figure 2. Plugin manager

To the left all Scipion plugins are listed. The tree menu is loaded from PyPi with the latest releases plugins names. Top right panel displays information for the selected plugin, such as name, version, release date, plugin description, url and the authors.

Installing plugins

At the bigining, all plugins are uninstalled and appears with the UNINSTALLED icon (). If you want to install any plugin, you need to do the following two steps.

1. Step 1: Check the selected plugin (we have two options)

   • Click on the UNINSTALLED icon .

   • Right-click on the plugin name and select the INSTALL option

     .

   In both cases, the selected plugin icon change to TO INSTALL icon () and the operation is shown in the bottom right panel on the Operations tab. We can select more than one plugin to install (Figure 3)

   Figure 3. Installing plugins

2. Step 2: Execute all selected operation

   Once all the operations have been selected, we proceed to execute them. For this, at the right bottom panel we have a tool bar with the action . This action execute automatically all operation that we have selected. When you click on the icon, Plugin manager is locked until all operation have been executed. Once all the operations have been executed, the status of the selected plugins changes as shown in the Figure 4. The selected plugins will appear as installed .

   if there is an error in the installation process, in the operations list the operation will appear as not executed , otherwise it will appear as executed icon .

   Before execute all operations, we can to cancel any operation by selecting one and clicking on the action or right-click on the plugin name and select de Undo operation .In the same way, we can to change the number of processors with which we want all the selected operations to be executed. By default it is 4 processors.

   Figure 4. Installed plugin

   Until Plugin manager execute the operations, on the Output log tab from the bottom rigth panel, we can observe the operations logs on the Plugin.log tab as the Figure 5 shows. If there are errors when executing these operations, Plugin.error shows a detailed list of these.

   Figure 5. Plugin manager logs

   When a plugin is installed, the binaries list is added to the plugin on the tree in the left panel. If we want to observe the binaries list we need to expand the plugin as shown in the Figure 6. It is important to mention that only the binaries that were defined by default in the plugin will be installed. If we need to install another or anothers binaries of any plugin, we just only to do the same procedure to install a plugin.

   Figure 6. Scipion-em-grigoriefflab binaries

Uninstalling plugins

In the same way that we install a set of plugins, we can uninstall them. For this, we need to select an installed plugin and follow these steps.

1. Step 1: Uncheck the selected plugin (we have two options)

   • Click on the INSTALLED icon .

   • Right-click on the plugin name and select the UNINSTALL option

     .

   In both cases, the selected plugin icon change to TO INSTALL icon () and the operation is shown in the bottom right panel on the Operations tab. We can select more than one plugin to uninstall (Figure 7)

   Figure 7. Uninstalling plugins

2. Step 2: Execute all selected operation

   Idem to Step 2 to Install Plugins

Updating plugins

if a new version of any plugin is released, Plugin Manager it is capable to detect the new version. In this case, the name of the plugin is highlighted in bold and, in the top right panel informs the user of the new version and how to update the plugin (see Figure 8).

Figure 8. Updating plugins

To update any plugin, we need to select an installed plugin, right-click on the plugin name and select the UPDATE option

.

In this case, the selected plugin icon change to TO UPDATE icon and the operation is shown in the bottom right panel on the Operations tab (Figure 9)

Figure 9. Uninstalling plugins

To execute the selected operation only we need to press the execute operation icon like Install or Uninstall any plugin or binary

Plugin Manager Glosary

Plugin Manager has a glossary of terms in the Help menu in the toolbar. This interface shows the icons that are used and their meaning as shown in the following figure.

Figure 10. Uninstalling plugins