qauvern 0.2.3

IBM Quantum load balancer for optimizing instance allocations

qauvern — IBM Quantum Load Balancer

A Python CLI tool for optimizing quantum instance allocations across projects to maximize utilization of IBM Quantum resources.

Overview

qauvern helps administrators manage quantum computing allocations efficiently by:

• Analyzing current instance usage and allocations
• Identifying underutilized instances
• Recommending optimal allocation adjustments
• Automatically applying optimizations to maximize resource utilization

Key Concepts

• QAU (Quantum Allocation Unit): 1 QAU = 1600 minutes of quantum computing time
• Rolling Window: 28-day backward-looking usage period
• Fairness: Ratio of consumed time to allocated time (lower fairness = higher priority)
• Allocation: Target consumption for an instance during the rolling window
• Limit: Hard cap on instance consumption
• Net Grant: Temporary time bonus above the base limit, active for a 28-day window. The effective limit decays as pre-grant usage rolls out of the window.

Installation

There are two ways to install qauvern:

• Pex — a single self-contained file you can download and run directly. No virtual environment or dependency management needed; just Python 3.10+ on your system. Best if you want to get running quickly or avoid modifying your Python environment. (What is Pex?)
• pip — a standard install from source into a virtual environment. Best if you want to pin a version in a requirements file or integrate with an existing Python workflow.

Option 1: Pex (single-file executable)

Download qauvern.pex from the GitHub Releases page. The Pex file only requires Python 3.10+ on your macOS or Linux system — no pip or virtual environment needed.

chmod +x qauvern.pex
./qauvern.pex --help

You can also build the Pex yourself if you have the repo cloned and Just installed (see CONTRIBUTING.md):

just pex
./dist/qauvern.pex --help

Option 2: pip install

Install "qauvern" into a virtual environment:

python3 -m venv .venv
source .venv/bin/activate
pip install qauvern

The qauvern CLI is available while the virtual environment is active:

qauvern --help

Configuration

Create a YAML configuration file defining your account, projects, and instances:

# config.yaml
account_id: "your-ibm-cloud-account-id"
plan_id: "91b2c828-2952-4f05-aed8-bedf92c6c480"  # Standard plan

# Minimum allocation to maintain for each instance (optional, default: 60 seconds)
minimum_allocation_seconds: 60

# Hold back a percentage of account allocation from rebalancing (optional, default: 0)
# allocation_reserve_percent: 20

balance_period:
  start_date: "2026-01-01T00:00:00"
  end_date: "2026-12-31T23:59:59"

projects:
  - name: "Quantum Chemistry Research"
    crn: "crn:v1:bluemix:public:quantum-computing:us-east:a/abc123:instance-1::"
    target_usage_seconds: 108000  # 30 hours (0.625 QAU) — optional

    # Optional: Hard limit applied on every optimize run
    # project_limit_seconds: 216000

    # Optional: Temporary time bonus above project_limit_seconds.
    # end_date is optional; defaults to start_date + 28 days if omitted.
    # net_grants:
    #   - start_date: "2026-05-01T00:00:00"
    #     net_grant_seconds: 360000  # 100 extra hours for a May sprint
    #   - start_date: "2026-06-15T00:00:00"
    #     end_date: "2026-07-31T00:00:00"
    #     net_grant_seconds: 180000

  - name: "Quantum Machine Learning"
    crn: "crn:v1:bluemix:public:quantum-computing:us-east:a/abc123:instance-2::"
    # No target_usage_seconds — allocation optimized between minimum and limit
    project_limit_seconds: 72000

See examples/config-example.yaml for a complete example.

Usage

Authentication

The tool uses IBM Cloud IAM for authentication. Set your IBM Cloud API key as an environment variable:

export IBMCLOUD_API_KEY="your-ibm-cloud-api-key"

Or pass it directly with the --api-key flag to any command.

Obtaining an IBM Cloud API Key

1. Log in to IBM Cloud
2. Go to Manage > Access (IAM) > API keys
3. Click Create an IBM Cloud API key
4. Give it a name and description
5. Copy the API key (you won't be able to see it again)

Commands

Configure (Generate Configuration)

Generate a base configuration file from an existing IBM Cloud account:

qauvern configure --account-id your-account-id --output config.yaml

This command will:

1. Connect to the IBM Quantum API
2. List all instances in the specified account
3. Generate a base YAML configuration file with one project per instance
4. Display a summary of found instances

Options:

• --account-id, -a: IBM Cloud account ID (required)
• --api-key, -k: IBM Cloud API key (or use IBMCLOUD_API_KEY env var)
• --output, -o: Output file path (default: config.yaml)
• --balance-start: Balance period start date (ISO format)
• --balance-end: Balance period end date (ISO format)

After generating the configuration, edit the file to set appropriate project names. Optionally set target_usage_seconds to enable balance-period tracking and exhaustion behavior; when omitted, allocation is optimized between minimum_allocation_seconds and project_limit_seconds.

Show Current Allocations

Display a summary of account and instance allocations:

qauvern show --config config.yaml

Output includes:

• Account summary (total allocation, consumption, utilization)
• Instance details with fairness values

Instances (Non-Admin View)

Display instance usage summary without requiring admin privileges:

qauvern instances --config config.yaml

This command only queries instance-level data and does not require account admin privileges, unlike the show command which accesses account-level allocation information.

Analyze Allocations

Analyze current allocations and show optimization recommendations without making changes:

qauvern analyze --config config.yaml

This command identifies underutilized instances, calculates optimal reallocations, and shows what changes would be made. The output includes a Cur Limit column (the live API value) and a New Limit column (what the optimizer would set). A (+grant) annotation indicates an active net grant is boosting the limit; ! indicates the instance is in debt.

Optimize Allocations

Apply optimization recommendations to update instance allocations:

qauvern optimize --config config.yaml
qauvern optimize --config config.yaml --dry-run   # preview only
qauvern optimize --config config.yaml --yes        # skip confirmation (for automation)

This command will:

1. Confirm you want to proceed (bypass with --yes)
2. Calculate optimal allocations
3. Display proposed changes
4. Apply allocation and limit updates via API

Use --dry-run to compute and display changes without applying them.

Create Instance

Provision a new IBM Quantum service instance:

qauvern create my-instance \
  --target us-east \
  --resource-group your-resource-group-id \
  --plan internal

Options:

• NAME (positional, required): Name for the new instance
• --target, -t: Deployment region (required, e.g., us-east, eu-de)
• --resource-group, -g: IBM Cloud resource group ID (required)
• --plan, -p: Plan name (internal, premium, paygo) or plan UUID (required)
• --allocation, -a: Initial allocation (e.g., 96000, 10h, 2.5d, 1qau)
• --limit, -l: Instance limit, set after creation (e.g., 10h, 1qau)
• --tag: Tags to apply (repeatable)

Staging Environment

To target the IBM Quantum staging environment (test.cloud.ibm.com) instead of production, use the --staging flag or set the IBMCLOUD_STAGING environment variable:

qauvern --staging analyze --config config-staging.yaml
# or
export IBMCLOUD_STAGING=True

The --staging flag is a global option and applies to all commands.

How It Works

Optimization Algorithm

1. Classify instances as active or inactive based on recent consumption
2. Reclaim allocation from inactive instances (down to the configured minimum)
3. Redistribute freed allocation to active instances weighted by fairness
4. Enforce limits using project_limit_seconds and any active net_grants

The optimizer targets low fairness values (< 0.5) to ensure instances receive scheduling priority from IBM Quantum's fair-share system. See the net_grants field in Configuration for details on how grant rolloff works.

Examples

Basic Workflow

# 1. Generate initial configuration from your account
qauvern configure --account-id your-account-id --output config.yaml

# 2. Edit config.yaml to organize instances into projects

# 3. Check current status
qauvern show --config config.yaml

# 4. Analyze and see recommendations
qauvern analyze --config config.yaml

# 5. Apply optimizations
qauvern optimize --config config.yaml

Continuous Optimization

Run the optimizer periodically (e.g., weekly) to maintain optimal allocations:

# Add to crontab for weekly optimization
0 0 * * 0 qauvern optimize --config /path/to/config.yaml --yes

Contributing

See CONTRIBUTING.md for development setup, running tests, and submitting changes.

For background on the IBM Quantum APIs that qauvern interacts with, see the IBM Quantum API docs.

For questions or bug reports, open an issue.

License

Apache License 2.0

Releasing

Releases are automated via GitHub Actions. To release a new version:

1. Bump version in pyproject.toml (semver: X.Y.Z)
2. Add a ## [X.Y.Z] section to CHANGELOG.md
3. Merge to main

The workflow validates the version, runs the test suite across Python 3.10–3.14, builds and publishes to PyPI, then creates a GitHub Release with a git tag.

Changelog

See CHANGELOG.md for version history and changes.