Installing plugins

The plugins available for AiiDA are listed on the AiiDA homepage

For a plugin aiida-plugin-template hosted on PyPI, simply do:

pip install aiida-plugin-template
reentry scan -r aiida   # notify aiida of new entry points

In case there is no PyPI package available, you can install the plugin from the python source, e.g.:

git clone https://github.com/aiidateam/aiida-plugin-template
pip install aiida-plugin-template
reentry scan -r aiida

Background

What does pip install aiida-plugin-template do?

  • resolves and installs the dependencies on other python packages as specified in setup.py
  • creates a folder aiida_plugin_template.egg-info/ with metadata about the package
  • if the -e option is given, creates a symbolic link from the python package search path to the aiida-plugin-template directory and puts the .egg-info folder there. Changes to the source code will be picked up by python without reinstalling, but changes to the metadata in setup.json will not.

For further details, see the Python packaging user guide.