Welcome to QHAna-Plugin-Runner’s documentation!

Note

This is the developer documentation for the QHAna Plugin Runner. The user documentation for QHAna can be found here.

Contents:

• A Runner for QHAna Plugins
  • VSCode
  • Development
  • What this Repository contains
  • Poetry Commands
  • Invoke Tasks
  • Babel
  • SQLAlchemy
  • Migrations
  • Celery background tasks
  • Compiling the Documentation
  • Updating the Third-Party Licenses
  • Unit Tests
  • Docker
  • Acknowledgements
  • Haftungsausschluss
  • Disclaimer of Warranty
• Writing Plugins
  • Plugin Code
  • Plugin API Layout
  • Plugin Metadata
  • Visualization Plugin Micro Frontend
  • Processing Plugin Micro Frontend
  • Processing Plugin Results
  • Conversion Plugins
  • Plugin Dependencies
  • Long Running Tasks
  • File Inputs
  • File Outputs
  • Writing Plugin Tests
• Writing Tests
  • Pytest setup
  • Test File Locations
  • Shared fixtures and helpers
  • Writing tests for the plugin runner
  • Writing tests for plugins
  • Testing Celery tasks
  • Property-based testing with hypothesis
  • Running tests
  • Continuous integration
  • See also
• Advanced Plugin Techniques
  • Creating Plugins at Runtime
  • Storing global State
  • Using existing Plugins in a Plugin Execution
• Special Plugin-Types
  • Quantum Circuit Executor Plugins
  • Minimizer Plugins
  • Objective Function Plugins
  • Interactions
• Data Formats defined for QHAna Plugins
  • Input Data Model
  • Data Loader Formats
  • Plugin Recipes
  • Data File Examples
• Cli Documentation of the Flask app
  • Flask Cli
  • DB Cli for Development
  • Cli commands to manage plugins and their dependencies
  • DB Cli for Migrations
  • Flask-Smorest Cli for OpenAPI Spec
  • Babel Cli for Translations
• All Plugins
  • Overview
  • Plugins
• Architectural Decision Log
  • 1. Template
  • 2. Use Markdown Architectural Decision Records
  • 3. Plugin Runner as Seperate Project
  • 4. Use Python
  • 5. Use Flask Template
  • 6. Use Celery Task Queue
  • 7. Plugins Must Provide Metadata
  • 8. Use MICRO-Frontends to Expose Algorithm Parameters
  • 9. Always Pass Files as URLs
  • 10. Complex Plugin Interactions
  • 11. Preprocessing Metadata to Apply the Same Processing to New Data [undecided]
  • 12. Repeating Steps in Multi-Step Plugins [undecided]
  • 13. Specify Additional Endpoints to used by Other Plugins
  • 14. Add a recipe data type [undecided]
  • 15. Subscribing for plugin updates
  • 16. Data inputs in substeps
  • 17. Schema links
  • 18. Celery Task Testing Strategy
  • 19. Co-locate plugin tests with plugin code
  • 20. Pipeline adaptation for comparing hierarchical Subparts (Muse4Music)
  • 21. Pipeline adaption for non-tree taxonomies
• qhana_plugin_runner package
  • Subpackages
  • Submodules
  • Module contents
• Changelog
  • [0.2.0] - 2022-12-30
  • [0.1.0] - 2021-08-03

Api Documentation

Api documentation

Indices and tables

• Index

• Module Index

• Search Page