{"id":24493,"library":"qm-octave","title":"QM Octave SDK","description":"SDK for controlling the Octave RF upconverter/downconverter from Quantum Machines, used together with the QUA framework. Current version 2.1.6, supports Python 3.9-3.12. Released regularly alongside QM software.","status":"active","version":"2.1.6","language":"python","source_language":"en","source_url":"https://github.com/qua-platform/qm-octave","tags":["quantum","hardware-control","octave","QUA"],"install":[{"cmd":"pip install qm-octave","lang":"bash","label":"Standard install"}],"dependencies":[{"reason":"Core QUA SDK required for Octave to connect to a QOP processor","package":"qm","optional":false}],"imports":[{"note":"Legacy import path; qm_octave no longer used as top-level package","wrong":"from qm_octave import OctaveConfig","symbol":"OctaveConfig","correct":"from qm.octave import OctaveConfig"}],"quickstart":{"code":"from qm import QuantumMachinesManager\nfrom qm.octave import OctaveConfig, QmOctaveController\n\n# Use environment variable for potential auth (simplified)\nconfig = OctaveConfig(\n    octave=\"octave1\",\n    connectivity=\"con1\",\n    clock=\"Internal\",\n    f_center=5e9,\n    gain=0,\n    lo_frequency=5e9\n)\n\n# Note: Requires a running QOP and qm package installed\nprint(\"OctaveConfig created successfully\")","lang":"python","description":"Create an Octave configuration and controller instance."},"warnings":[{"fix":"Replace Octave.connect() with QmOctaveController(config, quantum_machines_manager)","message":"The 'connect' method was removed in v2.0; use QmOctaveController directly.","severity":"breaking","affected_versions":"<2.0"},{"fix":"Remove calibration_db; calibration is handled automatically.","message":"'calibration_db' parameter in OctaveConfig is deprecated in 2.1.x.","severity":"deprecated","affected_versions":"2.1.x"},{"fix":"Refer to Octave documentation for correct parameter keys.","message":"OctaveConfig parameters like f_center, gain, and lo_frequency are case-sensitive and must exactly match the Octave hardware.","severity":"gotcha","affected_versions":"all"}],"env_vars":null,"last_verified":"2026-05-01T00:00:00.000Z","next_check":"2026-07-30T00:00:00.000Z","problems":[{"fix":"Install qm-octave and import from qm.octave: pip install qm-octave and from qm.octave import OctaveConfig","cause":"Using old import path or installing wrong package.","error":"ModuleNotFoundError: No module named 'qm_octave'"},{"fix":"Upgrade: pip install --upgrade qm-octave and ensure qm package is installed.","cause":"Outdated version of qm-octave or missing dependency.","error":"AttributeError: module 'qm.octave' has no attribute 'OctaveConfig'"}],"ecosystem":"pypi","meta_description":null,"install_score":null,"install_tag":null,"quickstart_score":null,"quickstart_tag":null}