Installing the Plugin

It is strongly recommended to install the plugin using the conda package manager which will also install the required RabbitMQ and PostgreSQL services. However, you may also install the plugin using either pip or directly from the plugin’s source code.


Be advised that the installation via pip or directly from source will not install the required RabbitMQ or PostgreSQL services automatically! While this allows you to use RabbitMQ or PostgreSQL installations already available on your system, it requires more manual work to get AiiDA setup and running. Thus, these installation routes are considered suitable only for advanced AiiDA users.

After the plugin has been installed you can check if the installation was successful by running the command

$ reentry scan
$ verdi plugin list aiida.calculations
Registered entry points for aiida.calculations:
* arithmetic.add
* cusp.vasp
* templatereplacer

The output of this command should now contain the new calculation entry point cusp.vasp.


Independent of the method you chose to install the plugin never forget to run reentry after successful installation in order to discover the newly added entry points using the command:

$ reentry scan

If this post-installation step is skipped new entry points installed by the plugin will not be discoverable and the plugin will not work as expected.

Installing via PIP (advanced)

To install the plugin via the pip installer run the command

$ pip install aiida-cusp

which will install the plugin and the required dependencies using the resources available from the python package index (PyPi).

Installing from Source (advanced)

Alternatively to the previous installation methods, install the plugin directly from source by cloning the plugin’s repository. After cloning go to the source root directory containing the project’s and run

$ python install