Developer Guide

Git is used for version control, and the source code repository is hosted here: https://github.com/iqm-finland/KQCircuits.

• Developer GUI Setup
  • Prerequisites
    • Python
  • Sources
  • Install
  • Unlinking
  • Update
  • Secondary install
  • Manual installation
    • Symlinks in Linux or MacOS
    • Symlinks in Windows
    • Installing dependencies
• Developer Standalone module Setup
  • Prerequisites
  • Installation
    • 1. Basic installation
    • 2. Reproducible, Secure Installation
    • 3. KQCircuits exclusive python environment
    • Dependency extensions
    • PyPI Installation
  • Usage
  • Jupyter notebook usage
  • Updating the required dependencies
• Containers
  • CLI usage
  • Docker CI usage
  • Singularity usage
• Architecture
  • Elements
  • PCell parameters
  • Libraries
  • pya resolver
• Testing
  • Unit tests
• Coding Style
• Documentation
• Contributing
  • Versioning