workflow for publishing docs

.github/workflows/docs.yml

@@ -0,0 +1,56 @@
+name: Documentation
+
+on:
+ push:
+ branches: [develop]
+
+ # Allows you to run this workflow manually from the Actions tab
+ workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+ contents: read
+ pages: write
+ id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between
+# the run in-progress and latest queued. However, do NOT cancel
+# in-progress runs as we want to allow these production deployments to
+# complete.
+concurrency:
+ group: "pages"
+ cancel-in-progress: false
+
+jobs:
+ build:
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@0ad4b8fadaa221de15dcec353f45205ec38ea70b # v4.1.4
+ - uses: actions/setup-python@82c7e631bb3cdc910f68e0081d67478d79c6982d #v5.1.0
+ with:
+ python-version: '3.11'
+ cache: 'pip'
+ - name: Install Dependencies
+ run: pip install -r requirements.txt
+ - name: Configure
+ run: cmake -B build docs
+ - name: Build documentation
+ run: cmake --build build -t all
+ - name: Setup Pages
+ id: pages
+ uses: actions/configure-pages@983d7736d9b0ae728b81ab479565c72886d7745b # v5.0.0
+ - name: Upload artifact
+ uses: actions/upload-pages-artifact@56afc609e74202658d3ffba0e8f6dda462b719fa # v3.0.1
+ with:
+ path: build/Documentation/html
+
+ deploy:
+ environment:
+ name: github-pages
+ url: ${{ steps.deployment.outputs.page_url }}
+ runs-on: ubuntu-latest
+ needs: build
+ steps:
+ - name: Deploy to GitHub Pages
+ id: deployment
+ uses: actions/deploy-pages@d6db90164ac5ed86f2b6aed7e0febac5b3c0c03e # v4.0.5

.github/workflows/pr.yml

@@ -0,0 +1,50 @@
+name: "PR Tests"
+permissions: read-all
+
+# Trigger for PR an merge to develop branch
+on:
+ push:
+ branches: develop
+ pull_request:
+ workflow_dispatch:
+
+env:
+ CTEST_OUTPUT_ON_FAILURE: 1
+ LAPACK_VERSION=v3.12.0
+ PARALLEL: -j 2
+
+jobs:
+ mkl:
+ runs-on: ubuntu-latest
+ # One runner for each domain
+ strategy:
+ matrix:
+ domain: [blas, dft, lapack, rng]
+ steps:
+ - uses: actions/checkout@v4
+ - name: Install netlib
+ run: |
+ curl -sL https://github.com/Reference-LAPACK/lapack/archive/refs/tags/v${LAPACK_VERSION}.tar.gz | tar zx
+ SHARED_OPT="lapack-${LAPACK_VERSION} -DBUILD_SHARED_LIBS=on -DCBLAS=on -DLAPACKE=on -DCMAKE_INSTALL_PREFIX=${PWD}/lapack/install"
+ # 32 bit int
+ cmake ${SHARED_OPT} -B lapack/build32 
+ cmake --build lapack/build32 ${PARALLEL} --target install
+ # 64 bit int
+ cmake ${SHARED_OPT} -DBUILD_INDEX64=on -B lapack/build64
+ cmake --build lapack/build64 ${PARALLEL} --target install
+ - name: Install oneapi
+ uses: rscohn2/setup-oneapi@v0
+ with:
+ components: |
+ icx@2024.1.0
+ mkl@2024.1.0
+ - name: Configure/Build for a domain
+ run: |
+ source /opt/intel/oneapi/setvars.sh
+ cmake -DREF_BLAS_ROOT=${PWD}/lapack/install -DREF_LAPACK_ROOT=${PWD}/lapack/install -DTARGET_DOMAINS=${{ matrix.domain }} -B build
+ cmake --build build ${PARALLEL}
+ - name: Run tests
+ run: |
+ source /opt/intel/oneapi/setvars.sh
+ # Run tests, skip GPU tests
+ ctest --test-dir build ${PARALLEL} -E 'gpu$'

requirements.txt

@@ -0,0 +1 @@
+Sphinx