Skip to main content

Onboarding Guide

Welcome to ORAQL! This guide will help you get started as a consortium member.

Access Setup​

1. GitHub Access​

  • You should have received an invitation to the ORAQL GitHub organization
  • Accept the invitation and set up two-factor authentication (2FA)
  • Join the appropriate teams based on your role:
    • hardware-demonstrators - For experimental work
    • theory-algorithms - For theoretical work
    • software-development - For open stack development
    • admin - For administrative staff

2. Digital Twin Access​

3. Communication Channels​

  • Join the ORAQL Slack workspace (or Teams, depending on consortium preference)
  • Subscribe to the quarterly newsletter
  • Add ORAQL calendar to stay informed of meetings and deadlines

Your First Tasks​

For Hardware Demonstrator Teams​

  1. Review your demonstrator track documentation
  2. Set up lab notebook protocol
  3. Schedule onboarding meeting with track lead
  4. Request equipment access and training

For Theory & Algorithms Teams​

  1. Review current QEC approaches and compilation methods
  2. Access computational resources (cluster access, software licenses)
  3. Schedule meeting with theory lead
  4. Set up development environment

For Software Developers​

  1. Review the Open Stack API Reference
  2. Clone the relevant repositories
  3. Set up local development environment
  4. Complete the "First Circuit" tutorial

Working with GitHub Issues​

All ORAQL work is tracked via GitHub issues:

Creating Issues​

  1. Navigate to the appropriate repository
  2. Click "New Issue"
  3. Select the template that matches your work:
    • Hardware Demonstrator - Experimental tasks
    • Theory Task - Theoretical work
    • Software Development - Code and tools
    • Administrative - Grants, reports, coordination
    • Bug Report - Issues with code or documentation

Issue Best Practices​

  • Use descriptive titles: [Hardware] Achieve 99.9% 2Q gate fidelity
  • Select appropriate labels (institution, priority, phase)
  • Link related issues
  • Update status regularly
  • Close issues only when complete and verified

Project Boards​

ORAQL uses GitHub project boards to track progress:

  • ORAQL Flagship System - Main system integration
  • Hardware Demonstrators - Five parallel tracks
  • Theory & Algorithms - Research efforts

Your issues will automatically appear on the relevant boards based on labels.

Data Management​

Digital Twin Data Logging​

All experimental data should be logged to the digital twin:

  1. Use standardized data formats (see Data Sharing Protocols)
  2. Include metadata: experiment ID, parameters, timestamp, institution
  3. Upload via the digital twin API or web interface
  4. Verify data appears in digital twin dashboard

Publication Protocol​

When publishing work:

  1. Acknowledge NSF support: "This work is supported by NSF Award [number]"
  2. Notify collaboration via GitHub issue (label: outreach, publication)
  3. Add publication to ORAQL bibliography
  4. Share preprint on collaboration Slack/Teams

NSF Reporting​

All team members contribute to NSF reporting:

  • Quarterly: Technical progress updates (brief)
  • Annual: Comprehensive report including:
    • Progress on demonstrators
    • Publications and presentations
    • Outreach activities
    • Budget status

Your PI will coordinate collection of this information.

Getting Help​

  • Technical Issues: Open a bug report on GitHub
  • Access Problems: Contact your institution's admin
  • General Questions: Post in Slack/Teams general channel
  • Urgent Matters: Email your PI or track lead

Key Resources​

  • CLAUDE.md: Development guidelines (in repository root)
  • Hardware Docs: Technical specifications for each demonstrator
  • Open Stack API: Comprehensive API documentation
  • Digital Twin: Performance data and model access

Training Requirements​

Before starting experimental work:

  • Lab safety training (institution-specific)
  • Data handling and security
  • GitHub workflow and issue tracking
  • Digital twin data logging
  • NSF reporting requirements

Next Steps​

  1. Complete access setup checklist
  2. Read documentation for your specific track
  3. Attend onboarding meeting with your team
  4. Review your first assigned GitHub issue
  5. Introduce yourself to the collaboration

Welcome to ORAQL! We're excited to have you on the team.