In this document the terms ‘python package’ and ‘python distribution’ are used to mean the following:
- python package
- a folder containing a file named
- python distribution
- a folder containing one or more python packages and a file named
setup.pywhich tells setuptools what should be installed and how.
In the python community the term ‘package’ is often used to refer to distributions as well.
What a Plugin Is¶
In principle a plugin is a self contained collection of one or more python modules (”.py files”), which provides a set of logically grouped extensions to AiiDA.
In technical terms, a plugin for AiiDA is a python distribution containing one or more python packages. It typically should have the aiida-core distribution as a requirement. It may import from the AiiDA package and provide entry points with extensions or workflows that integrate into AiiDA.
It may also provide commandline or GUI applications based on AiiDA functionality.
All publicly available plugins should be registered at the registry to avoid name-clashes with other plugins. Visiting the registry to see if the desired functionality is already being provided is a good idea as well.
What a Plugin Can Do¶
A plugin can do any of the following:
depend on the AiiDA distribution (and it normally will).
depend on any amount of other plugins;
depend on any number of other python distributions. However, the required versions must not clash with AiiDA’s requirements;
Provide classes that can be used together with AiiDA’s through a unified interface, including:
- data types;
- db importers;
- db exporters;
- subcommands to some
- tests to be run using
verdi devel tests.
This is typically achieved by subclassing the respective base class AiiDA provides for that purpose;
install separate commandline and/or GUI executables.
What a Plugin Cannot Do¶
It is important to keep in mind that, even though there is very little that is impossible to achieve, in the interest of a consistent and clear user experience there are things that should not be done.
Failure to comply with the points below will probably mean that your plugin will not be able to be listed as an officially endorsed plugin.
A plugin cannot (should not):
- change the database schema AiiDA uses;
- monkey patch anything within the
aiidanamespace or the namespace itself;
- in general, use a functionality of AiiDA or its classes which is marked as implementation detail: examples include functions, methods and classes starting with an underscore symbol: _.
- circumvent data provenance.
Should you find yourself tempted to do any of the above, you should post your usecase and reasoning as an issue on the AiiDA repository. If your change is actually more appropriate as a change to
aiida_core itself, you should then fork the repository, implement your changes and then create a pull request. You may also choose to ask on the AiiDA users mailing list for advice on how to proceed.
When to Contribute instead¶
In case it is unclear wether a certain functionality should be part of a plugin or of AiiDA itself, first ask yourself the following questions:
- is it impossible or very hard to implement as a separate package?
- would implementing it as a plugin involve any of the points listed in What a Plugin Cannot Do?
If you answered any of those questions with yes, we strongly encourage you to contribute to aiida_core instead.
would most users potentially profit from this functionality?
would many plugins profit from this functionality?
If yes, consider developing as a plugin and then open an issue on aiida_core, describing the functionality, why you think it should be in the main distribution, and linking to the repository for your plugin. We will then advise you on how to proceed.
If any of the above applies to only part of a planned plugin, please consider splitting them into a separate plugin (or contribution).