This repository contains the source of the official registry of AiiDA plugins.

If you are starting to develop a new plugin (e.g. using the AiiDA plugin cutter) or if you already have one, please register it here. We strongly encourage to register at early stages of development, since this both "reserves" the name of your plugin and informs the developer community of your ongoing work.

1. Fork this repository
2. Add your plugin to the end of the plugins.yaml file, e.g.

   ...
   aiida-new:
     entry_point_prefix: new
     plugin_info: https://raw.github.com/aiidateam/aiida-new/master/setup.json
     code_home: https://github.com/aiidateam/aiida-new
     documentation_url: http://aiida-new.readthedocs.io/
   

3. Create a Pull Request to this repository

The name under which your plugin will be distributed. By convention, names of AiiDA plugins are lowercase and prefixed by aiida-.

Examples:

• aiida-quantumespresso
• aiida-gaussian-datatypes

The prefix of all entry points provided by the plugin. By convention, a plugin aiida-xxx should use entry_point_prefix: xxx.

Example: aiida-quantumespresso uses the entry point prefix quantumespresso and provides numerous entry points, all of which start with quantumespresso..

The link to the homepage of the plugin, for example its github repository.

A URL or PyPI package name for installing the most recent version of the package through pip.

Examples:

• pip_url: aiida-quantumespresso for a package that is registered on PyPI
• pip_url: git+https://github.com/aiidateam/aiida-wannier90 for a package not registered on PyPI

URL pointing to a JSON file containing the keyword arguments passed to the setuptools.setup function when installing your package.

For an example, see the setup.json file of the aiida-diff demo plugin.

The link to the online documentation for your plugin, for example on readthedocs.org .

Use this to point to a Python module that contains a __version__ variable with the version of your plugin. Useful for flit and setuptools configuration files that use the programmatic version = attr: aiida_plugin.__version__ format.

The development status of a plugin used to be recorded explicitly on the plugin registry. Over time, we've moved closer and closer to adopting the development status trove classifer, so we now suggest to just use those in your setup.json/setup.cfg/... file of your plugin.

If no development status is specified, the status will default to 'planning'.