Implementing Quantum Computing Algorithms in Python

---
name: Implementing Quantum Computing Algorithms in Python
version: "1.0"
category: Python Cursor Rules
description: Guidelines for writing Python code that integrates with quantum computing frameworks like Qiskit and Cirq, focusing on best practices for quantum algorithm development.
globs:
  - "**/*.py"
triggers:
  - file_open
  - file_save
rules:
  - id: qc-imports
    description: Ensure proper import of quantum computing libraries.
    pattern: |
      import qiskit
      import cirq
    message: "Import Qiskit and Cirq at the beginning of your script to access quantum computing functionalities."
    severity: warning

  - id: qc-circuit-creation
    description: Use standard methods for creating quantum circuits.
    pattern: |
      from qiskit import QuantumCircuit
      qc = QuantumCircuit()
    message: "Use QuantumCircuit from Qiskit to create quantum circuits."
    severity: warning

  - id: qc-gate-application
    description: Apply quantum gates using standard methods.
    pattern: |
      qc.h(0)
      qc.cx(0, 1)
    message: "Apply Hadamard and CNOT gates using the .h() and .cx() methods of QuantumCircuit."
    severity: warning

  - id: qc-measurement
    description: Include measurements in quantum circuits.
    pattern: |
      qc.measure_all()
    message: "Include measurements in your quantum circuits using the measure_all() method."
    severity: warning

  - id: qc-simulation
    description: Simulate quantum circuits using appropriate backends.
    pattern: |
      from qiskit import Aer, execute
      backend = Aer.get_backend('qasm_simulator')
      result = execute(qc, backend).result()
    message: "Simulate your quantum circuits using the Aer simulator and execute functions from Qiskit."
    severity: warning

  - id: qc-cirq-circuit
    description: Create quantum circuits using Cirq.
    pattern: |
      import cirq
      qubits = [cirq.LineQubit(i) for i in range(2)]
      circuit = cirq.Circuit()
    message: "Use Cirq's LineQubit and Circuit classes to create quantum circuits."
    severity: warning

  - id: qc-cirq-gates
    description: Apply quantum gates in Cirq.
    pattern: |
      circuit.append([cirq.H(qubits[0]), cirq.CNOT(qubits[0], qubits[1])])
    message: "Apply Hadamard and CNOT gates in Cirq using the append method."
    severity: warning

  - id: qc-cirq-simulation
    description: Simulate Cirq circuits.
    pattern: |
      simulator = cirq.Simulator()
      result = simulator.run(circuit, repetitions=1000)
    message: "Simulate Cirq circuits using the Simulator class and run method."
    severity: warning

  - id: qc-error-handling
    description: Implement error handling in quantum programs.
    pattern: |
      try:
          # Quantum code
      except Exception as e:
          print(f"An error occurred: {e}")
    message: "Implement error handling using try-except blocks to catch exceptions in quantum programs."
    severity: warning

  - id: qc-documentation
    description: Document quantum functions and classes.
    pattern: |
      def function_name():
          """Function description."""
    message: "Provide docstrings for functions and classes to describe their purpose and usage."
    severity: warning