typos and Aqua CI

.github/dependabot.yml

@@ -5,3 +5,6 @@ updates:
     directory: "/" # Location of package manifests
     schedule:
       interval: "weekly"
+    ignore:
+      - dependency-name: "crate-ci/typos"
+        update-types: ["version-update:semver-patch"]

.github/workflows/SpellCheck.yml

@@ -0,0 +1,13 @@
+name: Spell Check
+
+on: [pull_request]
+
+jobs:
+  typos-check:
+    name: Spell Check with Typos
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Actions Repository
+        uses: actions/checkout@v3
+      - name: Check spelling
+        uses: crate-ci/typos@v1.16.23 

.typos.toml

@@ -0,0 +1,3 @@
+[default.extend-words]
+MOR = "MOR"
+FOM = "FOM"

Project.toml

@@ -16,9 +16,11 @@ TSVD = "9449cd9e-2762-5aa3-a617-5413e99d722e"
 
 [compat]
 DocStringExtensions = "0.8, 0.9"
+LinearAlgebra = "1"
 ModelingToolkit = "8.21"
 RandomizedLinAlg = "0.1"
 Setfield = "0.8, 1"
+SparseArrays = "1"
 SymbolicUtils = "0.19"
 Symbolics = "4.10"
 TSVD = "0.4"

src/DataReduction/POD.jl

@@ -37,7 +37,7 @@ mutable struct POD <: AbstractDRProblem
     rbasis::Any
     renergy::Any
     spectrum::Any
-    # constructers
+    # constructors
     function POD(snaps;
                  min_renergy = 1.0,
                  min_nmodes::Int = 1,

src/ErrorHandle.jl

@@ -3,7 +3,7 @@ function errorhandle(data::AbstractMatrix, nmodes::Int, max_energy, min_nmodes,
     s = minimum(size(data))
     @assert 0<nmodes<=s "Number of modes should be in {1,2,...,$s}."
     @assert min_nmodes<=max_nmodes "Minimum number of modes must lie below maximum number of modes"
-    @assert 0.0<=max_energy<=1.0 "Maxmimum relative energy must be in [0,1]"
+    @assert 0.0<=max_energy<=1.0 "Maximum relative energy must be in [0,1]"
 end
 
 function errorhandle(data::AbstractVector{T}, nmodes::Int, max_energy, min_nmodes,
@@ -12,5 +12,5 @@ function errorhandle(data::AbstractVector{T}, nmodes::Int, max_energy, min_nmode
     s = min(size(data, 1), size(data[1], 1))
     @assert 0<nmodes<=s "Number of modes should be in {1,2,...,$s}."
     @assert min_nmodes<=max_nmodes "Minimum number of modes must lie below maximum number of modes"
-    @assert 0.0<=max_energy<=1.0 "Maxmimum relative energy must be in [0,1]"
+    @assert 0.0<=max_energy<=1.0 "Maximum relative energy must be in [0,1]"
 end

src/deim.jl

@@ -170,6 +170,6 @@ function deim(sys::ODESystem, snapshot::AbstractMatrix, pod_dim::Integer;
                                                             kwargs...)
     @set! sys.observed = new_sorted_observed
 
-    inv_dict = Dict(Symbolics.scalarize(ŷ .=> V' * dvs)) # reduced vars to orignial vars
+    inv_dict = Dict(Symbolics.scalarize(ŷ .=> V' * dvs)) # reduced vars to original vars
     @set! sys.defaults = merge(ModelingToolkit.defaults(sys), inv_dict)
 end

test/Project.toml

@@ -1,4 +1,5 @@
 [deps]
+Aqua = "4c88cf16-eb10-579e-8560-4a9242c79595"
 DifferentialEquations = "0c46a032-eb83-5123-abaf-570d42b7fbaa"
 MethodOfLines = "94925ecb-adb7-4558-8ed8-f975c56a0bf4"
 ModelingToolkit = "961ee093-0014-501f-94e3-6117800e7a78"
@@ -7,6 +8,7 @@ Symbolics = "0c5d862f-8b57-4792-8d23-62f2024744c7"
 Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
 
 [compat]
+Aqua = "0.8"
 DifferentialEquations = "7.6"
 MethodOfLines = "0.6, 0.7"
 ModelingToolkit = "8.33"

test/deim.jl

@@ -49,6 +49,6 @@ deim_sol = solve(deim_prob, Tsit5(), saveat = 1.0)
 nₓ = length(sol[x])
 nₜ = length(sol[t])
 
-# test solution retrival
+# test solution retrieva
 @test size(deim_sol[v(x, t)]) == (nₓ, nₜ)
 @test size(deim_sol[w(x, t)]) == (nₓ, nₜ)

test/qa.jl

@@ -0,0 +1,12 @@
+using ModelOrderReduction, Aqua
+@testset "Aqua" begin
+    #Aqua.find_persistent_tasks_deps(ModelOrderReduction)
+    Aqua.test_ambiguities(ModelOrderReduction, recursive = false)
+    Aqua.test_deps_compat(ModelOrderReduction)
+    Aqua.test_piracies(ModelOrderReduction,
+        treat_as_own = [])
+    Aqua.test_project_extras(ModelOrderReduction)
+    Aqua.test_stale_deps(ModelOrderReduction)
+    Aqua.test_unbound_args(ModelOrderReduction)
+    Aqua.test_undefined_exports(ModelOrderReduction)
+end

test/runtests.jl

@@ -1,5 +1,6 @@
 using SafeTestsets
 
+@safetestset "Quality Assurance" begin include("qa.jl") end
 @safetestset "POD" begin include("DataReduction.jl") end
 @safetestset "utils" begin include("utils.jl") end
 @safetestset "DEIM" begin include("deim.jl") end