Quanifi documentation

Docker users: only a subset of processors is installed by default. The full catalogue includes processors that are not in the quickstart image. Add the processors you need to docker/processors.txt, then run docker compose up -d --build nifi. You can also select a custom list or all processors through .env. Enable additional processors.

This directory contains documentation for users and framework contributors. Research plans, experiment protocols and generated study reports are maintained in separate repositories.

Beginner Roadmap

If you are new to Quanifi, follow this 4-step pathway:

1. Module 1: Introduction to Quanifi — Understand the visual quantum software engineering paradigm and FlowFile dataflow model.
2. Developer Guide or Docker Quickstart — Set up your Python 3.12 environment with uv or launch the pre-packaged NiFi container.
3. Configuring flows on the NiFi canvas — Import and execute your first quantum flow using interactive "Run Once".
4. Interactive Tutorials Curriculum — Work through 6 step-by-step quantum algorithm modules (Deutsch-Jozsa, Bernstein-Vazirani, Grover, QAOA, Graph Decomposition).

Reference

• Component catalogue

Framework guides

• Docker quick start
• Developer guide
• Creating processors
• Configuring flows on the NiFi canvas
• pyQuil components and example canvases
• QAOA components, N×M flow and example canvases
• Interchangeable Grover components
• Data-driven testing
• Mutation testing on the canvas

Citation

If you use Quanifi in your research, please cite our preprint:

Neilson Carlos Leite Ramalho, Higor Amario de Souza, Anthony Accioly, Valter Vieira de Camargo, and Marcos Lordello Chaim. (2026). NxM-Version Programming for Quantum Software: High-Level Components across Frameworks and Engines. arXiv:2609.33255 [quant-ph]. https://arxiv.org/abs/2609.33255

@misc{ramalho2026nxmversionprogrammingquantumsoftware,
      title={NxM-Version Programming for Quantum Software: High-Level Components across Frameworks and Engines}, 
      author={Neilson Carlos Leite Ramalho and Higor Amario de Souza and Anthony Accioly and Valter Vieira de Camargo and Marcos Lordello Chaim},
      year={2026},
      eprint={2609.33255},
      archivePrefix={arXiv},
      primaryClass={quant-ph},
      url={https://arxiv.org/abs/2609.33255}, 
}

The introductory HTML examples are under Interactive Tutorials.