Plugin Development

• Basics
  • What a Plugin Is
  • Design guidelines
  • What a Plugin Can Do
  • What a Plugin Should Not Do
• Quickstart
• Entry Points
  • What is an Entry Point?
  • AiiDA Entry Points
  • aiida.calculations
  • aiida.parsers
  • aiida.data
  • aiida.workflows
  • aiida.cmdline
  • aiida.tools.dbexporters
  • aiida.tools.dbimporters
  • aiida.tools.dbexporters.tcod_plugins
  • aiida.schedulers
  • aiida.transports
• Documenting a plugin
• Publishing a plugin
  • 1. Choose a name
  • 2. Get Your Plugin Listed
  • 3. Get Your Plugin On PyPI
• Updating an Existing Plugin
  • Folder structure
  • Entry points
  • import statements
• The AiiDA Plugin System
  • Introduction
  • Goals
    • Sharing of workflows and extensions
    • Ease of use
    • Decouple development and update cycles of AiiDA and plugins
    • Promote modular design in AiiDA development
    • Low overhead for developers
    • Automatic AiiDA setup and testing of plugins
  • Mechanism overview
    • Example
  • Limitations
• Developing The Plugin System
  • Design Principles
  • Mini-Spec
    • Terms
    • Interfaces
      • Pluginloader (aiida/common/pluginloader.py)
      • Registry Tools (aiida/plugins)