Package setup

.github/workflows/FormatCheck.yml

@@ -0,0 +1,32 @@
+name: FormatCheck
+
+on:
+  push:
+    branches:
+      - 'main'
+    tags: '*'
+  pull_request:
+    branches:
+      - 'main'
+jobs:
+  build:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        version:
+          - '1' # automatically expands to the latest stable 1.x release of Julia
+        os:
+          - ubuntu-latest
+        arch:
+          - x64
+    steps:
+      - uses: julia-actions/setup-julia@latest
+        with:
+          version: ${{ matrix.version }}
+          arch: ${{ matrix.arch }}
+
+      - uses: actions/checkout@v4
+      - name: Install JuliaFormatter and format
+        run: |
+          julia -e 'using Pkg; Pkg.add(PackageSpec(name="JuliaFormatter"))'
+          julia -e 'using JuliaFormatter; format(".", verbose=true)'

.github/workflows/Tests.yml

@@ -0,0 +1,41 @@
+name: Tests
+on:
+  push:
+    branches:
+      - 'master'
+      - 'main'
+      - 'release-'
+    tags: '*'
+    paths-ignore:
+      - 'docs/**'
+  pull_request:
+  workflow_dispatch:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  # Cancel intermediate builds: only if it is a pull request build.
+  cancel-in-progress: ${{ startsWith(github.ref, 'refs/pull/') }}
+
+jobs:
+  tests:
+    name: "Tests"
+    strategy:
+      fail-fast: false
+      matrix:
+        version:
+          - 'lts' # minimal supported version
+          - '1' # latest released Julia version
+        # group:
+        os:
+          - ubuntu-latest
+          - macOS-latest
+          - windows-latest
+    uses: "QuantumKitHub/QuantumKitHubActions/.github/workflows/Tests.yml@main"
+    with:
+      group: "${{ matrix.group }}"
+      nthreads: 4
+      julia-version: "${{ matrix.version }}"
+      os: "${{ matrix.os }}"
+      timeout-minutes: 120
+    secrets:
+      CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

README.md

@@ -1,5 +1,22 @@
 # MatrixAlgebraKit
 
-[![Build Status](https://github.com/Jutho Haegeman/MatrixAlgebraKit.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/Jutho Haegeman/MatrixAlgebraKit.jl/actions/workflows/CI.yml?query=branch%3Amain)
-[![Coverage](https://codecov.io/gh/Jutho Haegeman/MatrixAlgebraKit.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/Jutho Haegeman/MatrixAlgebraKit.jl)
-[![Aqua](https://raw.githubusercontent.com/JuliaTesting/Aqua.jl/master/badge.svg)](https://github.com/JuliaTesting/Aqua.jl)
+A Julia interface for matrix algebra, with a focus on performance, flexibility and extensibility.
+
+| **Documentation** | **Build Status** | **Coverage** | **Quality assurance** |
+|:-----------------:|:----------------:|:------------:|:---------------------:|
+| [![][docs-stable-img]][docs-stable-url] [![][docs-dev-img]][docs-dev-url] | [![CI][ci-img]][ci-url] | [![Codecov][codecov-img]][codecov-url] | [![Aqua QA][aqua-img]][aqua-url] |
+
+[docs-stable-img]: https://img.shields.io/badge/docs-stable-blue.svg
+[docs-stable-url]: https://QuantumKitHub.github.io/MatrixAlgebraKit.jl/stable
+
+[docs-dev-img]: https://img.shields.io/badge/docs-dev-blue.svg
+[docs-dev-url]: https://QuantumKitHub.github.io/MatrixAlgebraKit.jl/latest
+
+[ci-img]: https://github.com/QuantumKitHub/MatrixAlgebraKit.jl/actions/workflows/CI.yml/badge.svg
+[ci-url]: https://github.com/QuantumKitHub/MatrixAlgebraKit.jl/actions/workflows/CI.yml
+
+[codecov-img]: https://codecov.io/gh/QuantumKitHub/MatrixAlgebraKit.jl/branch/master/graph/badge.svg
+[codecov-url]: https://codecov.io/gh/QuantumKitHub/MatrixAlgebraKit.jl
+
+[aqua-img]: https://raw.githubusercontent.com/JuliaTesting/Aqua.jl/master/badge.svg
+[aqua-url]: https://github.com/JuliaTesting/Aqua.jl

src/eig.jl

@@ -96,4 +96,4 @@ function eig_trunc!(A::AbstractMatrix, alg::LAPACK_EighAlgorithm,
     V′ = V[:, ind]
     D′ = Diagonal(Dd[ind])
     return (D′, V′)
-end
+end

src/eigh.jl

@@ -99,4 +99,4 @@ function eigh_trunc!(A::AbstractMatrix, alg::LAPACK_EighAlgorithm,
     V′ = V[:, ind]
     D′ = Diagonal(Dd[ind])
     return (D′, V′)
-end
+end

src/svd.jl

@@ -172,4 +172,4 @@ function svd_trunc!(A::AbstractMatrix, alg::LAPACK_SVDAlgorithm, trunc::Truncati
     S′ = Diagonal(Sd[ind])
     Vᴴ′ = Vᴴ[ind, :]
     return (U′, S′, Vᴴ′)
-end
+end

src/truncation.jl

@@ -34,4 +34,4 @@ end
 function findtruncated(values::AbstractVector, strategy::TruncationKeepFiltered)
     ind = findall(strategy.filter, values)
     return ind
-end
+end