Skip to content

[FEATURE] Add pyqasm[pulse] extra to pyproject.toml and related files #182

@TheGupta2012

Description

@TheGupta2012

Feature Description

Add a new pulse extra to the pyqasm package, allowing users to install optional dependencies required for pulse/calibration features via pip install pyqasm[pulse].

Motivation

Pulse and calibration features (such as those used in OpenPulse or QASM3 calibration blocks) may require additional dependencies that are not needed for core QASM parsing or circuit features. Providing an installable extra ensures users can opt-in to these dependencies only when needed, keeping the base install lightweight

Implementation (Optional)

  1. Modify pyproject.toml:

    • Add a [project.optional-dependencies] section (or update it if it exists).
    • Define a pulse extra with the relevant dependencies (e.g., numpy, scipy, or any libraries required for pulse processing).
    [project.optional-dependencies]
    pulse = [
        "numpy",
        "scipy",
        # Add any other dependencies needed for pulse features
    ]
    
  2. Update Documentation:

    • Document the new extra in the README and any other relevant docs.
    • Provide installation instructions, e.g.:
      pip install pyqasm[pulse]
      
  3. (Optional) Add Tests:

    • If there are pulse-specific modules or features, ensure that CI installs the pulse extra and runs relevant tests.
  4. Update requirements.txt (if used):

    • If the repository maintains a requirements.txt for development or CI, ensure it covers the pulse dependencies as needed.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or requestqasm3-coverageAdding support for qasm3 constructs

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions