Runic formatter (#293)

* Runic formatting

* update actions and workflows

Author: lkdvos

.JuliaFormatter.toml

@@ -15,7 +15,7 @@ concurrency:
 
 jobs:
   test:
-    name: Julia ${{ matrix.version }} - ${{ matrix.os }} - ${{ matrix.arch }}
+    name: Julia ${{ matrix.version }} - ${{ matrix.os }}
     runs-on: ${{ matrix.os }}
     strategy:
       fail-fast: false

.github/workflows/CI.yml

@@ -11,7 +11,7 @@ on:
   workflow_dispatch:
 
 jobs:
-  build:
+  Documentation:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:

.github/workflows/Documentation.yml

@@ -1,44 +1,15 @@
-name: FormatCheck
+name: 'Format'
 
 on:
-  push:
-    branches:
-      - 'main'
-      - 'master'
-      - 'release-'
-    tags: '*'
-  pull_request:
+  pull_request_target:
+    paths: ['**/*.jl']
+    types: [opened, synchronize, reopened, ready_for_review]
 
-jobs:
-  build:
-    runs-on: ${{ matrix.os }}
-    strategy:
-      matrix:
-        version:
-          - '1' # automatically expands to the latest stable 1.x release of Julia
-        os:
-          - ubuntu-latest
-    steps:
-      - uses: julia-actions/setup-julia@latest
-        with:
-          version: ${{ matrix.version }}
+permissions:
+  contents: read
+  actions: write
+  pull-requests: write
 
-      - uses: actions/checkout@v5
-      - name: Install JuliaFormatter and format
-        # This will use the latest version by default but you can set the version like so:
-        #
-        # julia  -e 'using Pkg; Pkg.add(PackageSpec(name="JuliaFormatter", version="0.13.0"))'
-        run: |
-          julia  -e 'using Pkg; Pkg.add(PackageSpec(name="JuliaFormatter", version="1"))'
-          julia  -e 'using JuliaFormatter; format(".", verbose=true)'
-      - name: Format check
-        run: |
-          julia -e '
-          out = Cmd(`git diff --name-only`) |> read |> String
-          if out == ""
-              exit(0)
-          else
-              @error "Some files have not been formatted !!!"
-              write(stdout, out)
-              exit(1)
-          end'
+jobs:
+  formatcheck:
+    uses: "QuantumKitHub/QuantumKitHubActions/.github/workflows/FormatCheck.yml@main"

.github/workflows/FormatCheck.yml

@@ -0,0 +1,5 @@
+repos:
+  - repo: https://github.com/fredrikekre/runic-pre-commit
+    rev: v2.0.1
+    hooks:
+      - id: runic

.pre-commit-config.yaml

@@ -11,13 +11,15 @@ BenchmarkTools.DEFAULT_PARAMETERS.memory_tolerance = 0.01
 
 const PARAMS_PATH = joinpath(@__DIR__, "etc", "params.json")
 const SUITE = BenchmarkGroup()
-const MODULES = Dict("linalg" => :LinalgBenchmarks,
-                     "indexmanipulations" => :IndexManipulationBenchmarks,
-                     "tensornetworks" => :TensorNetworkBenchmarks)
+const MODULES = Dict(
+    "linalg" => :LinalgBenchmarks,
+    "indexmanipulations" => :IndexManipulationBenchmarks,
+    "tensornetworks" => :TensorNetworkBenchmarks
+)
 
 load!(id::AbstractString; kwargs...) = load!(SUITE, id; kwargs...)
 
-function load!(group::BenchmarkGroup, id::AbstractString; tune::Bool=false)
+function load!(group::BenchmarkGroup, id::AbstractString; tune::Bool = false)
     modsym = MODULES[id]
     modpath = joinpath(dirname(@__FILE__), id, "$(modsym).jl")
     Core.eval(@__MODULE__, :(include($modpath)))
@@ -33,14 +35,14 @@ end
 
 loadall!(; kwargs...) = loadall!(SUITE; kwargs...)
 
-function loadall!(group::BenchmarkGroup; verbose::Bool=true, tune::Bool=false)
+function loadall!(group::BenchmarkGroup; verbose::Bool = true, tune::Bool = false)
     for id in keys(MODULES)
         if verbose
             print("loading group $(repr(id))... ")
-            time = @elapsed load!(group, id, tune=false)
+            time = @elapsed load!(group, id, tune = false)
             println("done (took $time seconds)")
         else
-            load!(group, id; tune=false)
+            load!(group, id; tune = false)
         end
     end
     if tune

benchmark/TensorKitBenchmarks/TensorKitBenchmarks.jl

@@ -25,15 +25,15 @@ function benchmark_permute!(benchgroup, params::Dict)
     end
     return nothing
 end
-function benchmark_permute!(bench; sigmas=nothing, T="Float64", I="Trivial", dims, p)
+function benchmark_permute!(bench; sigmas = nothing, T = "Float64", I = "Trivial", dims, p)
     T_ = parse_type(T)
     I_ = parse_type(I)
 
     p_ = (Tuple(p[1]), Tuple(p[2]))
     Vs = generate_space.(I_, dims, sigmas)
 
-    codomain = mapreduce(Base.Fix1(getindex, Vs), ⊗, p_[1]; init=one(eltype(Vs)))
-    domain = mapreduce(Base.Fix1(getindex, Vs), ⊗, p_[2]; init=one(eltype(Vs)))
+    codomain = mapreduce(Base.Fix1(getindex, Vs), ⊗, p_[1]; init = one(eltype(Vs)))
+    domain = mapreduce(Base.Fix1(getindex, Vs), ⊗, p_[2]; init = one(eltype(Vs)))
     init() = init_permute_tensors(T_, codomain ← domain, p_)
 
     bench[T, I, dims, sigmas, p] = @benchmarkable permute!(C, A, $p_) setup = ((C, A) = $init())

benchmark/TensorKitBenchmarks/indexmanipulations/IndexManipulationBenchmarks.jl

@@ -28,7 +28,7 @@ function benchmark_mul!(benchgroup, params::Dict)
     return nothing
 end
 
-function benchmark_mul!(bench; sigmas=nothing, T="Float64", I="Trivial", dims)
+function benchmark_mul!(bench; sigmas = nothing, T = "Float64", I = "Trivial", dims)
     T_ = parse_type(T)
     I_ = parse_type(I)
 
@@ -62,7 +62,7 @@ function benchmark_svd!(benchgroup, params::Dict)
     end
     return nothing
 end
-function benchmark_svd!(bench; sigmas=nothing, T="Float64", I="Trivial", dims)
+function benchmark_svd!(bench; sigmas = nothing, T = "Float64", I = "Trivial", dims)
     T_ = parse_type(T)
     I_ = parse_type(I)
     Vs = generate_space.(I_, dims, sigmas)

benchmark/TensorKitBenchmarks/linalg/LinalgBenchmarks.jl

@@ -32,7 +32,7 @@ function benchmark_mpo!(benchgroup, params::Dict)
     end
     return nothing
 end
-function benchmark_mpo!(bench; sigmas=nothing, T="Float64", I="Trivial", dims)
+function benchmark_mpo!(bench; sigmas = nothing, T = "Float64", I = "Trivial", dims)
     T_ = parse_type(T)
     I_ = parse_type(I)
 
@@ -64,8 +64,8 @@ end
 
 function benchmark_pepo(A, P, FL, FD, FR, FU)
     return @tensor FL[18, 7, 4, 2, 1] * FU[1, 3, 6, 9, 10] * A[2, 17, 5, 3, 11] *
-                   P[4, 16, 8, 5, 6, 12] * conj(A[7, 15, 8, 9, 13]) *
-                   FR[10, 11, 12, 13, 14] * FD[14, 15, 16, 17, 18]
+        P[4, 16, 8, 5, 6, 12] * conj(A[7, 15, 8, 9, 13]) *
+        FR[10, 11, 12, 13, 14] * FD[14, 15, 16, 17, 18]
 end
 
 function benchmark_pepo!(benchgroup, params::Dict)
@@ -76,7 +76,7 @@ function benchmark_pepo!(benchgroup, params::Dict)
     end
     return nothing
 end
-function benchmark_pepo!(bench; sigmas=nothing, T="Float64", I="Trivial", dims)
+function benchmark_pepo!(bench; sigmas = nothing, T = "Float64", I = "Trivial", dims)
     T_ = parse_type(T)
     I_ = parse_type(I)
 
@@ -105,11 +105,18 @@ function init_mera_tensors(T, V)
 end
 
 function benchmark_mera(u, w, ρ, h)
-    return @tensor (((((((h[9, 3, 4, 5, 1, 2] * u[1, 2, 7, 12]) * conj(u[3, 4, 11, 13])) *
-                        (u[8, 5, 15, 6] * w[6, 7, 19])) *
-                       (conj(u[8, 9, 17, 10]) * conj(w[10, 11, 22]))) *
-                      ((w[12, 14, 20] * conj(w[13, 14, 23])) * ρ[18, 19, 20, 21, 22, 23])) *
-                     w[16, 15, 18]) * conj(w[16, 17, 21]))
+    return @tensor (
+        (
+            (
+                (
+                    (
+                        ((h[9, 3, 4, 5, 1, 2] * u[1, 2, 7, 12]) * conj(u[3, 4, 11, 13])) *
+                            (u[8, 5, 15, 6] * w[6, 7, 19])
+                    ) * (conj(u[8, 9, 17, 10]) * conj(w[10, 11, 22]))
+                ) * ((w[12, 14, 20] * conj(w[13, 14, 23])) * ρ[18, 19, 20, 21, 22, 23])
+            ) * w[16, 15, 18]
+        ) * conj(w[16, 17, 21])
+    )
 end
 
 function benchmark_mera!(benchgroup, params::Dict)
@@ -121,7 +128,7 @@ function benchmark_mera!(benchgroup, params::Dict)
     return nothing
 end
 
-function benchmark_mera!(bench; sigmas=nothing, T="Float64", I="Trivial", dims)
+function benchmark_mera!(bench; sigmas = nothing, T = "Float64", I = "Trivial", dims)
     T_ = parse_type(T)
     I_ = parse_type(I)
 

benchmark/TensorKitBenchmarks/tensornetworks/TensorNetworkBenchmarks.jl

@@ -8,8 +8,9 @@ using TensorKit
 parse_type(x::String) = eval(Meta.parse(x))
 
 function expand_kwargs(params::Dict)
-    const_params = NamedTuple(Symbol(key) => value
-                              for (key, value) in params if !(value isa Vector))
+    const_params = NamedTuple(
+        Symbol(key) => value for (key, value) in params if !(value isa Vector)
+    )
     nonconst_keys = Tuple(Symbol(key) for (key, value) in params if value isa Vector)
     nonconst_vals = (value for value in values(params) if value isa Vector)
     return Iterators.map(Iterators.product(nonconst_vals...)) do expanded_vals
@@ -22,15 +23,15 @@ end
 
 Creates a (graded) vector space with sectortype `I` and total dimension `D`, where the distribution of charges is controlled through a spread parameter `sigma`.
 """
-function generate_space(::Type{Trivial}, D::Int, sigma::Nothing=nothing)
+function generate_space(::Type{Trivial}, D::Int, sigma::Nothing = nothing)
     return ComplexSpace(round(Int, D))
 end
-function generate_space(::Type{Z2Irrep}, D::Int, sigma::Real=0.5)
+function generate_space(::Type{Z2Irrep}, D::Int, sigma::Real = 0.5)
     D_even = ceil(Int, sigma * D)
     D_odd = D - D_even
     return Z2Space(0 => D_even, 1 => D_odd)
 end
-function generate_space(::Type{U1Irrep}, D::Int, sigma::Real=0.5)
+function generate_space(::Type{U1Irrep}, D::Int, sigma::Real = 0.5)
     # use ceil here to avoid getting stuck
     normal_pdf = let D = D
         x -> ceil(Int, D * exp(-0.5 * (x / sigma)^2) / (sigma * sqrt(2π)))
@@ -54,7 +55,7 @@ function generate_space(::Type{U1Irrep}, D::Int, sigma::Real=0.5)
 
     return U1Space((s => d for (s, d) in zip(sectors, dims))...)
 end
-function generate_space(::Type{SU2Irrep}, D::Int, sigma::Real=0.5)
+function generate_space(::Type{SU2Irrep}, D::Int, sigma::Real = 0.5)
     normal_pdf = let D = D
         x -> D * exp(-0.5 * (x / sigma)^2) / (sigma * sqrt(2π))
     end