[Infra] Use custom docker image in CI

.github/workflows/build_docs.yml

@@ -0,0 +1,56 @@
+name: Build documentation
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+  workflow_dispatch: {}
+
+concurrency:
+  group: docs-${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
+
+jobs:
+  test_qadence_ubuntu:
+    name: Test Qadence docs (ubuntu)
+    runs-on: ubuntu-22.04
+    steps:
+
+    - 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@v4
+      with:
+        python-version: '3.10'
+
+    - name: Install Hatch
+      run: |
+        pip install hatch
+
+    - name: Build docs
+      if: ${{ !startsWith(github.ref, 'ref/tags/v') }}
+      run: |
+        hatch -v run docs:build
+
+    - name: Deploy docs
+      if: startsWith(github.ref, 'ref/tags/v')
+      run: |
+        echo "VERSION=${GITHUB_REF#refs/tags/}" >> $GITHUB_ENV
+        git config user.name "GitHub Actions"
+        git config user.email "[email protected]"
+        mike deploy --push --update-aliases $VERSION latest

.github/workflows/lint.yml

@@ -1,6 +1,9 @@
-name: Lint and type check Qadence.
+name: linting and type check
 
 on:
+  push:
+    branches:
+      - main
   pull_request: {}
   workflow_dispatch: {}
 
@@ -10,7 +13,8 @@ jobs:
     runs-on: ubuntu-22.04
 
     steps:
-    - uses: actions/checkout@v4
+    - name: Checkout Qadence
+      uses: actions/checkout@v4
     - name: Set up Python 3.x
       uses: actions/setup-python@v4
       with:

.github/workflows/test_all.yml

@@ -14,12 +14,15 @@ jobs:
   test_qadence_ubuntu:
     name: Test Qadence (ubuntu)
     runs-on: ubuntu-22.04
+    strategy:
+      matrix:
+        python-version: ["3.9", "3.10"]
     steps:
     - uses: actions/checkout@v4
-    - name: Select Python 3.10
+    - name: Set up Python ${{ matrix.python-version }}
       uses: actions/setup-python@v4
       with:
-        python-version: '3.10'
+        python-version: ${{ matrix.python-version }}
     - name: Install Hatch
       run: |
         pip install hatch

.github/workflows/test_examples.yml → .github/workflows/test_examples_notebooks.yml

@@ -1,4 +1,4 @@
-name: Run Qadence example tests.
+name: Run Qadence example and notebook tests.
 
 on:
   push:
@@ -9,8 +9,10 @@ on:
       - main
   paths:
     - examples
-  paths-ignore:
-    - examples/notebooks
+    - notebooks
+  schedule:
+    # 03:00 every Saturday morning
+    - cron: '0 3 * * 6'
   workflow_dispatch: {}
 
 concurrency:
@@ -33,3 +35,6 @@ jobs:
     - name: Run example tests
       run: |
         hatch -v run test-examples
+    - name: Run notebooks tests
+      run: |
+        hatch -v run test-notebooks

.github/workflows/test_fast.yml

@@ -1,4 +1,4 @@
-name: Run Qadence fast tests.
+name: fast tests
 
 on:
   push:
@@ -14,18 +14,27 @@ concurrency:
   cancel-in-progress: true
 
 jobs:
-  test_qadence_ubuntu:
+  test_qadence_ubuntu_310:
     name: Test Qadence (ubuntu)
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-latest
+    container:
+      image: pasqalofficial/qadence_fast_310:latest
     steps:
-    - uses: actions/checkout@v4
-    - name: Select Python 3.10
-      uses: actions/setup-python@v4
+    - name: Checkout Qadence
+      uses: actions/checkout@v3
+    - name: Set up Python 3.10
+      uses: actions/setup-python@v3
       with:
-        python-version: '3.10'
+        python-version: "3.10"
     - name: Install Hatch
       run: |
         pip install hatch
     - name: Run fast tests
       run: |
         hatch -v run test -m "not slow"
+    - name: Upload coverage data
+      uses: actions/upload-artifact@v3
+      with:
+        name: "coverage-data"
+        path: .coverage.*
+        if-no-files-found: ignore

.gitignore

@@ -49,12 +49,28 @@ runs/
 # Mkdocs
 site/
 
-# converted notebooks
-docs/**/*.py
-
 # pt files
 *.pt
 
 # event files
 events.out.tfevents.*
 /examples/notebooks/onboarding_sandbox.ipynb
+
+# latex
+*.aux
+*.lof
+*.log
+*.lot
+*.fls
+*.out
+*.toc
+*.fmt
+*.fot
+*.cb
+*.cb2
+*.lb
+*.pdf
+*.ps
+*.dvi
+
+*.gv

.pre-commit-config.yaml

@@ -9,13 +9,13 @@ repos:
         args: ['--maxkb=600']
 
 -   repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: "v0.0.288"
+    rev: "v0.0.291"
     hooks:
       - id: ruff
-        args: [--fix, --show-fixes, --show-source]
+        args: [--fix, --show-fixes, --show-source, --exclude, examples/draw.py]
 
 -   repo: https://github.com/ambv/black
-    rev: 23.7.0
+    rev: 23.9.1
     hooks:
       - id: black
 

CODE_OF_CONDUCT.md

@@ -0,0 +1,33 @@
+# Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+- The use of sexualized language or imagery and unwelcome sexual attention or advances
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic address, without explicit permission
+- Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.