Merge pull request #20 from pasqal-io/rg/publish-to-pypi

[Infra] CI files for lint, test and publish.

.github/workflows/lint.yml

@@ -0,0 +1,31 @@
+name: Linting
+
+on:
+  push:
+    branches:
+      - main
+  pull_request: {}
+  workflow_dispatch: {}
+
+jobs:
+  lint:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout Qadence
+      uses: actions/checkout@v4
+
+    - name: Set up Python 3.x
+      uses: actions/setup-python@v5
+      with:
+        python-version: '3.x'
+
+    - name: Install pre-commit
+      run: |
+        pip install pre-commit
+        pre-commit install
+
+    - name: Check files
+      run: |
+        pre-commit run --all-files

.github/workflows/test.yml

@@ -0,0 +1,112 @@
+name: Tests
+
+on:
+  push:
+    branches:
+      - main
+    tags:
+      - 'v[0-9]+.[0-9]+.[0-9]+'
+  pull_request:
+    branches:
+      - main
+  workflow_dispatch: {}
+
+concurrency:
+  group: fast-${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
+
+jobs:
+
+  test_qadence_ubuntu:
+    name: Qadence Platforms (ubuntu)
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11"]
+    steps:
+    - name: Checkout Qadence Platforms
+      uses: actions/checkout@v4
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install Hatch
+      run: |
+        pip install hatch
+    - name: Run tests
+      run: |
+        hatch -v run test
+    - name: Upload coverage data
+      uses: actions/upload-artifact@v4
+      with:
+        name: "coverage-data"
+        path: .coverage.*
+        if-no-files-found: ignore
+
+  publish:
+    name: Publish to PyPI
+    if: startsWith(github.ref, 'refs/tags/v')
+    needs: test_qadence_ubuntu
+    runs-on: ubuntu-latest
+    permissions:
+      # IMPORTANT: this permission is mandatory for trusted publishing
+      id-token: write
+    steps:
+      - name: Check out Qadence
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ github.ref }}
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.10"
+      - name: Install Python dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install hatch
+      - name: Build and publish package
+        run: |
+          hatch build
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+      - name: Confirm deployment
+        timeout-minutes: 5
+        run: |
+          VERSION=${GITHUB_REF#refs/tags/v}
+          until pip download qadence2_expressions==$VERSION
+          do
+            echo "Failed to download from PyPI, will wait for upload and retry."
+            sleep 1
+          done
+
+  deploy_docs:
+    name: Deploy Qadence Platforms docs (ubuntu)
+    if: startsWith(github.ref, 'refs/tags/v')
+    needs: test_qadence_ubuntu
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout Qadence Platforms
+      uses: actions/checkout@v4
+    - name: Install JetBrains Mono font
+      run: |
+        sudo apt install -y wget unzip fontconfig
+        wget https://download.jetbrains.com/fonts/JetBrainsMono-2.304.zip
+        unzip JetBrainsMono-2.304.zip -d JetBrainsMono
+        mkdir -p /usr/share/fonts/truetype/jetbrains
+        cp JetBrainsMono/fonts/ttf/*.ttf /usr/share/fonts/truetype/jetbrains/
+        fc-cache -f -v
+    - name: Install graphviz
+      run: sudo apt-get install -y graphviz
+    - name: Set up Python 3.10
+      uses: actions/setup-python@v5
+      with:
+        python-version: '3.10'
+    - name: Install Hatch
+      run: |
+        pip install hatch
+    - name: Deploy docs
+      run: |
+        git config user.name "GitHub Actions"
+        git config user.email "[email protected]"
+        git fetch origin gh-pages
+        hatch -v run docs:mike deploy --push --update-aliases ${{ github.ref_name }} latest

pyproject.toml

@@ -3,10 +3,10 @@ requires = ["hatchling"]
 build-backend = "hatchling.build"
 
 [project]
-name = "qadence2_platforms"
+name = "qadence2-platforms"
 description = "Platform-dependent engines and model to execute compiled expressions with common set of methods."
 readme = "README.md"
-version = "0.1.0"
+version = "0.1.1"
 requires-python = ">=3.10,<3.12"
 license = {text = "Proprietary"}
 keywords = ["quantum"]
@@ -39,10 +39,11 @@ allow-ambiguous-features = true
 [project.optional-dependencies]
 extras = [
 ]
+
 [project.urls]
-# Documentation = "https://pqs.pages.pasqal.com/qadence2-platforms/"
-Issues = "https://github.com/pasqal-io/wip-qadence2-platforms/issues"
-Source = "https://github.com/pasqal-io/wip-qadence2-platforms"
+Documentation = "https://pqs.pages.pasqal.com/qadence2-platforms/"
+Issues = "https://github.com/pasqal-io/qadence2-platforms/-/issues"
+Source = "https://github.com/pasqal-io/qadence2-platforms"
 
 [tool.hatch.envs.default]
 features = ["extras"]
@@ -54,9 +55,14 @@ dependencies = [
   "ipykernel",
   "pre-commit",
   "black",
-  "ruff"
+  "isort",
+  "ruff",
+  "pydocstringformatter",
 ]
 
+[tool.hatch.envs.default.scripts]
+test = "pytest -n auto --cov-config=pyproject.toml --ignore=./tests/test_examples.py {args}"
+
 [tool.pytest.ini_options]
 testpaths = ["tests"]
 addopts = """-vvv --cov-report=term-missing --cov-config=pyproject.toml --cov=template_python --cov=tests"""
@@ -86,13 +92,11 @@ dependencies = [
 [tool.hatch.envs.docs.scripts]
 build = "mkdocs build --clean --strict {args}"
 serve = "mkdocs serve --dev-addr localhost:8000"
+test = "mkdocs build --clean --strict"
 
 [[tool.hatch.envs.test.matrix]]
 python = ["310", "311"]
 
-[tool.hatch.build.targets.wheel]
-packages = ["qadence2_platforms"]
-
 [tool.hatch.build.targets.sdist]
 exclude = [
     "/.gitignore",
@@ -103,6 +107,9 @@ exclude = [
     "/qadence2_platforms/backends/user_backends"
 ]
 
+[tool.hatch.build.targets.wheel]
+packages = ["qadence2_platforms"]
+
 [tool.coverage.run]
 branch = true
 parallel = true
@@ -124,6 +131,7 @@ exclude_lines = [
 lint.select = ["E", "F", "I", "Q"]
 lint.extend-ignore = ["F841"]
 line-length = 100
+lint.exclude = ["*.ipynb"]
 
 [tool.ruff.lint.isort]
 required-imports = ["from __future__ import annotations"]
@@ -137,6 +145,23 @@ max-complexity = 15
 [tool.ruff.lint.flake8-quotes]
 docstring-quotes = "double"
 
+[tool.black]
+line-length = 100
+include = '\.pyi?$'
+exclude = '''
+/(
+    \.git
+  | \.hg
+  | \.mypy_cache
+  | \.tox
+  | \.venv
+  | _build
+  | buck-out
+  | build
+  | dist
+)/
+'''
+
 [tool.mypy]
 python_version = "3.10"
 warn_return_any = true

qadence2_platforms/backends/fresnel1/compiler.py

@@ -9,7 +9,5 @@
 def compile_to_backend(model: Model) -> Interface:
     reg = register.from_model(model)
     seq = sequence.from_model(model, reg)
-    non_trainable_parameters = {
-        k for k, v in model.inputs.items() if not v.is_trainable
-    }
+    non_trainable_parameters = {k for k, v in model.inputs.items() if not v.is_trainable}
     return Interface(seq, non_trainable_parameters)

qadence2_platforms/backends/fresnel1/functions.py

@@ -144,9 +144,7 @@ def apply_local_shifts(sequence: Sequence, **_: Any) -> None:
         sequence.device.channels["rydberg_global"].max_abs_detuning or DEFAULT_DETUNING
     )
     time_scale = 1000 * 2 * np.pi / max_abs_detuning
-    local_pulse_core(
-        sequence, duration=1.0, time_scale=time_scale, detuning=1.0, concurrent=False
-    )
+    local_pulse_core(sequence, duration=1.0, time_scale=time_scale, detuning=1.0, concurrent=False)
 
 
 def local_pulse(
@@ -175,9 +173,7 @@ def local_pulse_core(
 
     if duration == Duration.FILL:
         if not concurrent:
-            raise SyntaxError(
-                "The option `fill` can only be used on the `concurrent` mode"
-            )
+            raise SyntaxError("The option `fill` can only be used on the `concurrent` mode")
 
         duration = sequence.get_duration("global") - sequence.get_duration("dmm_0")
     else:

qadence2_platforms/backends/fresnel1/interface.py

@@ -33,9 +33,7 @@ def set_parameters(self, params: dict[str, float]) -> None:
         valid_params = params.keys() & self._non_trainable_parameters
 
         if valid_params != params.keys():
-            raise ValueError(
-                f"{set(params.keys())} are not fixed parameters in this sequence."
-            )
+            raise ValueError(f"{set(params.keys())} are not fixed parameters in this sequence.")
 
         self._params = params
 

qadence2_platforms/backends/fresnel1/register.py

@@ -49,9 +49,7 @@ def from_model(model: Model) -> RegisterLayout:
     transform = np.array([[1.0, 0.0], [0.5, 0.8660254037844386]])
     coords = coords @ transform
 
-    layout = AnalogDevice.calibrated_register_layouts[
-        "TriangularLatticeLayout(61, 5.0µm)"
-    ]
+    layout = AnalogDevice.calibrated_register_layouts["TriangularLatticeLayout(61, 5.0µm)"]
     coords *= 5
     traps = layout.get_traps_from_coordinates(*coords)
     register = layout.define_register(*traps, qubit_ids=range(len(traps)))