Merge pull request #116 from ytdHuang/ci/spell-check

Add spell check CI

.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@v4
+      - name: Check spelling
+        uses: crate-ci/[email protected]

.typos.toml

@@ -0,0 +1,3 @@
+[default.extend-words]
+ket = "ket"
+Commun = "Commun" # for journal abbreviation: Commun. Phys.

docs/src/bath_boson/bosonic_bath_intro.md

@@ -63,7 +63,7 @@ c_list = C(bath, tlist)
 Here, `c_list` is a list which contains the value of ``C(t)`` corresponds to the given time series `tlist`.
 
 ## Exponent
-`HierarchicalEOM.jl` also supports users to access the specific exponential term with brakets `[]`. This returns an [`Exponent`](@ref) object, which contains the corresponding value of ``\eta_i`` and ``\gamma_i``:
+`HierarchicalEOM.jl` also supports users to access the specific exponential term with brackets `[]`. This returns an [`Exponent`](@ref) object, which contains the corresponding value of ``\eta_i`` and ``\gamma_i``:
 ```julia
 e = bath[2] # the 2nd-term
 print(e)

docs/src/bath_boson_RWA/bosonic_bath_RWA_intro.md

@@ -48,7 +48,7 @@ cp_list, cm_list = C(bath, tlist)
 Here, `cp_list` and `cm_list` are the lists which contain the value of ``C^{\nu=+}(t)`` and ``C^{\nu=-}(t)`` correspond to the given time series `tlist`, respectively.
 
 ## Exponent
-`HierarchicalEOM.jl` also supports users to access the specific exponential term with brakets `[]`. This returns an [`Exponent`](@ref) object, which contains the corresponding value of ``\eta_i^\nu`` and ``\gamma_i^\nu``:
+`HierarchicalEOM.jl` also supports users to access the specific exponential term with brackets `[]`. This returns an [`Exponent`](@ref) object, which contains the corresponding value of ``\eta_i^\nu`` and ``\gamma_i^\nu``:
 ```julia
 e = bath[2] # the 2nd-term
 print(e)

docs/src/bath_fermion/fermionic_bath_intro.md

@@ -51,7 +51,7 @@ cp_list, cm_list = C(bath, tlist)
 Here, `cp_list` and `cm_list` are the lists which contain the value of ``C^{\nu=+}(t)`` and ``C^{\nu=-}(t)`` correspond to the given time series `tlist`, respectively.
 
 ## Exponent
-`HierarchicalEOM.jl` also supports users to access the specific exponential term with brakets `[]`. This returns an [`Exponent`](@ref) object, which contains the corresponding value of ``\eta_i^\nu`` and ``\gamma_i^\nu``:
+`HierarchicalEOM.jl` also supports users to access the specific exponential term with brackets `[]`. This returns an [`Exponent`](@ref) object, which contains the corresponding value of ``\eta_i^\nu`` and ``\gamma_i^\nu``:
 ```julia
 e = bath[2] # the 2nd-term
 print(e)

examples/cavityQED.jl

@@ -144,7 +144,7 @@ Plots.xaxis!(L"\omega")
 # ## Compare with Master Eq. approach
 # (see also [HEOMLS for Master Equations](@ref doc-Master-Equation))
 #   
-# The Lindblad master equations which describs the cavity couples to an extra bosonic reservoir with [Drude-Lorentzian spectral density](@ref Boson-Drude-Lorentz) is given by
+# The Lindblad master equations which describes the cavity couples to an extra bosonic reservoir with [Drude-Lorentzian spectral density](@ref Boson-Drude-Lorentz) is given by
 
 ## Drude_Lorentzian spectral density
 Drude_Lorentz(ω, Γ, W) = 4 * Γ * W * ω / ((ω)^2 + (W)^2)

src/ADOs.jl

@@ -38,7 +38,7 @@ ADOs(data::SparseVector{ComplexF64,Int64}, dims::AbstractVector, N::Int, parity:
 
 @doc raw"""
     ADOs(V, N, parity)
-Gernerate the object of auxiliary density operators for HEOM model.
+Generate the object of auxiliary density operators for HEOM model.
 
 # Parameters
 - `V::AbstractVector` : the vectorized auxiliary density operators
@@ -58,7 +58,7 @@ end
 
 @doc raw"""
     ADOs(ρ, N, parity)
-Gernerate the object of auxiliary density operators for HEOM model.
+Generate the object of auxiliary density operators for HEOM model.
 
 # Parameters
 - `ρ` : the reduced density operator

src/bath/BosonBath.jl

@@ -282,7 +282,7 @@ function bosonImag(op::QuantumObject, η_imag::Vector{Ti}, γ_imag::Vector{Tj})
 end
 
 @doc raw"""
-    sturct bosonRealImag <: AbstractBosonBath
+    struct bosonRealImag <: AbstractBosonBath
 A bosonic bath which the real part and imaginary part of the bath correlation function are combined 
 
 # Fields

src/bath/FermionBath.jl

@@ -210,7 +210,7 @@ end
 @doc raw"""
     C(bath, tlist)
 Calculate the correlation function ``C^{\nu=+}(t)`` and ``C^{\nu=-}(t)`` for a given fermionic bath and time list.
-Here, ``\nu=+`` represents the absorption process and ``\nu=-`` represents the emmision process.
+Here, ``\nu=+`` represents the absorption process and ``\nu=-`` represents the emission process.
 
 ```math
 C^{\nu=\pm}(t)=\sum_i \eta_i^\nu e^{-\gamma_i^\nu t}

src/heom_matrices/heom_matrix_base.jl

@@ -317,7 +317,7 @@ D_{\textrm{even}}[J](\cdot) = J(\cdot) J^\dagger - \frac{1}{2}\left(J^\dagger J
 ```
 where ``J\equiv \sqrt{\gamma}V`` is the jump operator, ``V`` describes the dissipative part (operator) of the dynamics, ``\gamma`` represents a non-negative damping rate and ``[\cdot, \cdot]_+`` stands for anti-commutator.
 
-Similary, the dissipator with `ODD` parity is defined as follows
+Similarly, the dissipator with `ODD` parity is defined as follows
 ```math
 D_{\textrm{odd}}[J](\cdot) = - J(\cdot) J^\dagger - \frac{1}{2}\left(J^\dagger J (\cdot) + (\cdot) J^\dagger J \right),
 ```

test/ADOs.jl

@@ -13,7 +13,7 @@
         @test ρ_b[i] == ado
     end
 
-    # expections for expect
+    # exceptions for expect
     ados_wrong = ADOs(spzeros(Int64, 18), 2)
     @test_throws ErrorException expect(Qobj([0 0 0; 0 0 0; 0 0 0]), ados_f)
     @test_throws ErrorException expect(Qobj([0 0; 0 0]), [ados_b, ados_wrong])

test/HEOMSuperOp.jl

@@ -92,7 +92,7 @@
         @test WTD_heom[i] ≈ WTD_ans[i] atol = 1e-5
     end
 
-    ## test for ERRORs
+    ## test for error
     J_wrong1 = HEOMSuperOp(γ_eR * d, ODD, M_me, "L")
     J_wrong2 = HEOMSuperOp(γ_eR * d, EVEN, M_heom, "L")
     @test_throws ErrorException HEOMSuperOp(d, EVEN, M_heom, "LR")