Fix #182: added pulse dependency/docs

.github/workflows/main.yml

@@ -102,7 +102,7 @@ jobs:
           CIBW_ARCHS_LINUX: x86_64
           CIBW_MANYLINUX_X86_64_IMAGE: ${{ matrix.manylinux_image }}
           CIBW_BEFORE_BUILD: bash {project}/bin/cibw/pre_build.sh {project}
-          CIBW_TEST_EXTRAS: "test,cli"
+          CIBW_TEST_EXTRAS: "test,cli,pulse"
           CIBW_TEST_COMMAND: bash {project}/bin/cibw/test_wheel.sh {project}
           CIBW_BUILD_VERBOSITY: 1
 

CHANGELOG.md

@@ -15,6 +15,7 @@ Types of changes:
 ## Unreleased
 
 ### Added
+- Added the `pulse` extra dependency to the `pyproject.toml` file, which includes the `openpulse` package. This allows users to install pulse-related functionality when needed. ([#195](https://github.com/qBraid/pyqasm/pull/195))
 
 ### Improved / Modified
 

README.md

@@ -27,6 +27,26 @@ PyQASM requires Python 3.10 or greater, and can be installed with pip as follows
 pip install pyqasm
 ```
 
+### Optional Dependencies
+
+PyQASM provides an optional extra called pyqasm[pulse] that adds pulse/calibration features.
+
+```bash
+pip install pyqasm[pulse]
+```
+
+PyQASM also offers optional extras for command-line interface (CLI) functionality and for program visualization.
+
+To install the CLI tools:
+```bash
+pip install pyqasm[cli]
+```
+
+To install the visualization tools:
+```bash
+pip install pyqasm[visualization]
+```
+
 ### Install from source 
 
 You can also install from source by cloning this repository and running a pip install command

pyproject.toml

@@ -44,6 +44,7 @@ test = ["pytest", "pytest-cov", "pytest-mpl", "matplotlib"]
 lint = ["black", "isort>=6.0.0", "pylint", "mypy", "qbraid-cli>=0.10.2"]
 docs = ["sphinx>=7.3.7,<8.3.0", "sphinx-autodoc-typehints>=1.24,<3.2", "sphinx-rtd-theme>=2.0.0,<4.0.0", "docutils<0.22", "sphinx-copybutton"]
 visualization = ["matplotlib"]
+pulse = ["openpulse[parser]>=1.0.1"]
 
 [tool.setuptools.package-data]
 pyqasm = ["py.typed", "*.pyx"]

tests/pulse/test_import.py

@@ -0,0 +1,22 @@
+# Copyright 2025 qBraid
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""Tests for pulse functionality."""
+
+import pytest
+
+
+def test_openpulse_import():
+    """Tests that openpulse can be imported if pyqasm[pulse] is installed."""
+    pytest.importorskip("openpulse")

tox.ini

@@ -16,6 +16,7 @@ description = Run pytests and generate coverage report.
 extras =
     test
     cli
+    pulse
 commands =
     pytest tests --cov=pyqasm --cov-config=pyproject.toml --cov-report=term --cov-report=xml {posargs}