rename TRGKit to TNRKit

Project.toml

@@ -1,4 +1,4 @@
-name = "TRGKit"
+name = "TNRKit"
 uuid = "7dfc3ef0-df9b-475f-b8e2-b91f34f5d84d"
 authors = ["VictorVanthilt <[email protected]>"]
 version = "0.1.0"

README.md

@@ -1,7 +1,5 @@
-# TRGKit.jl
+# TNRKit.jl
 ---
-*(name subject to change)* 
-
 Is a Julia package that aims to implement as much tensor network renormalization (TNR) schemes as possible.
 It is built upon
 [TensorKit.jl](https://github.com/jutho/TensorKit.jl), which provides functionality for

examples/example.jl

@@ -1,6 +1,4 @@
-using Revise, TensorKit
-includet("../src/TRGKit.jl")
-using .TRGKit
+using Revise, TensorKit, TNRKit
 
 # criterion to determine convergence
 trg_f(steps::Int, data) = abs(log(data[end]) * 2.0^(-steps))

src/TRGKit.jl → src/TNRKit.jl

@@ -1,4 +1,4 @@
-module TRGKit
+module TNRKit
 using TensorKit, LinearAlgebra
 using LoggingExtras, Printf
 using Zygote, OptimKit
@@ -9,7 +9,7 @@ export maxiter, convcrit
 export trivial_convcrit
 
 # schemes
-include("schemes/trgscheme.jl")
+include("schemes/tnrscheme.jl")
 include("schemes/trg.jl")
 include("schemes/btrg.jl")
 include("schemes/hotrg.jl")
@@ -18,7 +18,7 @@ include("schemes/gilt-tnr.jl")
 include("schemes/atrg.jl")
 include("schemes/slooptnr.jl")
 
-export TRGScheme
+export TNRScheme
 export TRG, trg_convcrit
 export BTRG, btrg_convcrit
 export HOTRG, hotrg_convcrit

src/models/gross-neveu.jl

@@ -55,6 +55,6 @@ function gross_neveu_start(μ::Number, m::Number, g::Number)
     @tensor T_fused[-1 -2; -3 -4] := T_unfused[1 2 3 4; 5 6 7 8] * U[-1; 1 2] * U[-2; 3 4] *
                                      Udg[5 6; -3] * Udg[7 8; -4]
 
-    # restore the TRGKit.jl convention
-    return permute(T_fused, (1, 2), (4, 3))
+    # restore the TNRKit.jl convention
+    return permute(T_fused, ((1, 2), (4, 3)))
 end

src/schemes/atrg.jl

@@ -1,4 +1,4 @@
-mutable struct ATRG <: TRGScheme
+mutable struct ATRG <: TNRScheme
     T::TensorMap
 
     finalize!::Function

src/schemes/btrg.jl

@@ -1,4 +1,4 @@
-mutable struct BTRG <: TRGScheme
+mutable struct BTRG <: TNRScheme
     T::TensorMap
     S1::TensorMap
     S2::TensorMap

src/schemes/gilt-tnr.jl

@@ -1,4 +1,4 @@
-mutable struct GILTTNR <: TRGScheme
+mutable struct GILTTNR <: TNRScheme
     T::TensorMap
 
     ε::Float64

src/schemes/hotrg.jl

@@ -1,4 +1,4 @@
-mutable struct HOTRG <: TRGScheme
+mutable struct HOTRG <: TNRScheme
     T::TensorMap
 
     finalize!::Function

src/schemes/slooptnr.jl

@@ -1,5 +1,5 @@
 # TODO: rewrite SLoopTNR contractions to work with symmetric tensors
-mutable struct SLoopTNR <: TRGScheme
+mutable struct SLoopTNR <: TNRScheme
     T::TensorMap
 
     optimization_algorithm::OptimKit.OptimizationAlgorithm

src/schemes/trgscheme.jl → src/schemes/tnrscheme.jl

@@ -1,9 +1,9 @@
-abstract type TRGScheme end
+abstract type TNRScheme end
 
 function step! end
 function finalize! end
 
-function run!(scheme::TRGScheme, trscheme::TensorKit.TruncationScheme, criterion::stopcrit;
+function run!(scheme::TNRScheme, trscheme::TensorKit.TruncationScheme, criterion::stopcrit;
               finalize_beginning=true, verbosity=1)
     data = []
 
@@ -30,7 +30,7 @@ function run!(scheme::TRGScheme, trscheme::TensorKit.TruncationScheme, criterion
     return data
 end
 
-function run!(scheme::TRGScheme, trscheme::TensorKit.TruncationScheme;
+function run!(scheme::TNRScheme, trscheme::TensorKit.TruncationScheme;
               finalize_beginning=true, verbosity=1)
     # default maxiter criterion of 100 iterations
     return run!(scheme, trscheme, maxiter(100); finalize_beginning=finalize_beginning,

src/schemes/trg.jl

@@ -1,4 +1,4 @@
-mutable struct TRG <: TRGScheme
+mutable struct TRG <: TNRScheme
     T::TensorMap
 
     finalize!::Function

src/utility/cft.jl

@@ -1,4 +1,4 @@
-function cft_data(scheme::TRGScheme; v=1, unitcell=1)
+function cft_data(scheme::TNRScheme; v=1, unitcell=1)
     # make the indices
     indices = [[i, -i, i + 1, -(i + unitcell)] for i in 1:unitcell]
     indices[end][3] = 1
@@ -28,7 +28,7 @@ function cft_data(scheme::BTRG; v=1, unitcell=1)
     throw(NotImplementedError("BTRG requires extra care with the environment tensors, this method will be implemented later"))
 end
 
-function central_charge(scheme::TRGScheme, trunc::TensorKit.TruncationScheme,
+function central_charge(scheme::TNRScheme, trunc::TensorKit.TruncationScheme,
                         stop::stopcrit)
     data = run!(scheme, trunc, stop; finalize_beginning=true)
     @tensor M[-1; -2] := (scheme.T / data[end])[1 -1; 1 -2]
@@ -45,6 +45,6 @@ function central_charge(scheme::BTRG, trunc::TensorKit.TruncationScheme, stop::s
 end
 
 # default maxiter criterion of 15 iterations
-function central_charge(scheme::TRGScheme, trunc::TensorKit.TruncationScheme)
+function central_charge(scheme::TNRScheme, trunc::TensorKit.TruncationScheme)
     return central_charge(scheme, trunc, maxiter(15))
 end

test/runtests.jl

@@ -1,5 +1,5 @@
 using Test
-using TRGKit
+using TNRKit
 using TensorKit
 
 using QuadGK