rename to SpatiallySymmetricTensors.jl

tangwei94 · Jan 29, 2025 · 8eb77a0 · 8eb77a0 · tangwei94 · Jan 29, 2025
1 parent 485718d
commit 8eb77a0
Show file tree

Hide file tree

Showing 8 changed files with 28 additions and 26 deletions.
diff --git a/Project.toml b/Project.toml
@@ -1,4 +1,4 @@
-name = "SpatiallySymmetricTensor"
+name = "SpatiallySymmetricTensors"
 uuid = "267f34df-16a8-4a72-a26d-fb880b511394"
 authors = ["Wei Tang <[email protected]> and contributors"]
 version = "0.1.0"

diff --git a/README.md b/README.md
@@ -1,9 +1,11 @@
-# SpatiallySymmetricTensor
+# SpatiallySymmetricTensors
 
-[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://tangwei94.github.io/SpatiallySymmetricTensor.jl/stable/)
-[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://tangwei94.github.io/SpatiallySymmetricTensor.jl/dev/)
-[![Build Status](https://github.com/tangwei94/SpatiallySymmetricTensor.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/tangwei94/SpatiallySymmetricTensor.jl/actions/workflows/CI.yml?query=branch%3Amain)
-[![Coverage](https://codecov.io/gh/tangwei94/SpatiallySymmetricTensor.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/tangwei94/SpatiallySymmetricTensor.jl)
+<!---
+[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://tangwei94.github.io/SpatiallySymmetricTensors.jl/stable/)
+[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://tangwei94.github.io/SpatiallySymmetricTensors.jl/dev/)
+-->
+[![Build Status](https://github.com/tangwei94/SpatiallySymmetricTensors.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/tangwei94/SpatiallySymmetricTensors.jl/actions/workflows/CI.yml?query=branch%3Amain)
+[![Coverage](https://codecov.io/gh/tangwei94/SpatiallySymmetricTensors.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/tangwei94/SpatiallySymmetricTensors.jl)
 
 This package aims to provide a simple way to combine point group symmetries (e.g., C4v, C3v) with internal symmetries (e.g., SU(2), U(1)) within the framework of [TensorKit.jl](https://github.com/Jutho/TensorKit.jl). 
 
@@ -13,7 +15,7 @@ The internal SU(2) symmetry will be handled by TensorKit.jl, while the spatial s
 
 ```julia 
 using TensorKit
-using SpatiallySymmetricTensor 
+using SpatiallySymmetricTensors 
 ```
 
 We first specify the physical/virtual space for the PEPS tensor

diff --git a/docs/Project.toml b/docs/Project.toml
@@ -1,3 +1,3 @@
 [deps]
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
-SpatiallySymmetricTensor = "267f34df-16a8-4a72-a26d-fb880b511394"
+SpatiallySymmetricTensors = "267f34df-16a8-4a72-a26d-fb880b511394"
diff --git a/docs/make.jl b/docs/make.jl
@@ -1,16 +1,16 @@
-using SpatiallySymmetricTensor
+using SpatiallySymmetricTensors
 using Documenter
 
-DocMeta.setdocmeta!(SpatiallySymmetricTensor, :DocTestSetup, :(using SpatiallySymmetricTensor); recursive=true)
+DocMeta.setdocmeta!(SpatiallySymmetricTensors, :DocTestSetup, :(using SpatiallySymmetricTensors); recursive=true)
 
 makedocs(;
-    modules=[SpatiallySymmetricTensor],
+    modules=[SpatiallySymmetricTensors],
     authors="Wei Tang <[email protected]> and contributors",
-    repo="https://github.com/tangwei94/SpatiallySymmetricTensor.jl/blob/{commit}{path}#{line}",
-    sitename="SpatiallySymmetricTensor.jl",
+    repo="https://github.com/tangwei94/SpatiallySymmetricTensors.jl/blob/{commit}{path}#{line}",
+    sitename="SpatiallySymmetricTensors.jl",
     format=Documenter.HTML(;
         prettyurls=get(ENV, "CI", "false") == "true",
-        canonical="https://tangwei94.github.io/SpatiallySymmetricTensor.jl",
+        canonical="https://tangwei94.github.io/SpatiallySymmetricTensors.jl",
         edit_link="main",
         assets=String[],
     ),
@@ -20,6 +20,6 @@ makedocs(;
 )
 
 deploydocs(;
-    repo="github.com/tangwei94/SpatiallySymmetricTensor.jl",
+    repo="github.com/tangwei94/SpatiallySymmetricTensors.jl",
     devbranch="main",
 )
diff --git a/docs/src/index.md b/docs/src/index.md
@@ -1,14 +1,14 @@
 ```@meta
-CurrentModule = SpatiallySymmetricTensor
+CurrentModule = SpatiallySymmetricTensors
 ```
 
-# SpatiallySymmetricTensor
+# SpatiallySymmetricTensors
 
-Documentation for [SpatiallySymmetricTensor](https://github.com/tangwei94/SpatiallySymmetricTensor.jl).
+Documentation for [SpatiallySymmetricTensors](https://github.com/tangwei94/SpatiallySymmetricTensors.jl).
 
 ```@index
 ```
 
 ```@autodocs
-Modules = [SpatiallySymmetricTensor]
+Modules = [SpatiallySymmetricTensors]
 ```
diff --git a/src/SpatiallySymmetricTensor.jl → src/SpatiallySymmetricTensors.jl b/src/SpatiallySymmetricTensor.jl → src/SpatiallySymmetricTensors.jl
@@ -1,4 +1,4 @@
-module SpatiallySymmetricTensor
+module SpatiallySymmetricTensors
 
 __precompile__(true)
 

diff --git a/test/runtests.jl b/test/runtests.jl
@@ -1,7 +1,7 @@
 using Test
 using LinearAlgebra, TensorKit, TensorOperations
 using Revise
-using SpatiallySymmetricTensor
+using SpatiallySymmetricTensors
 
 include("test_spatial_operations.jl");
 include("test_square_lattice_SU2.jl");

diff --git a/test/test_square_lattice_SU2.jl b/test/test_square_lattice_SU2.jl
@@ -1,23 +1,23 @@
 @testset "test T_1_3_A1" begin
-    T1 = SpatiallySymmetricTensor.T_1_3_A1()
-    T2 = SpatiallySymmetricTensor.T_1_3_A1_from_plain()
+    T1 = SpatiallySymmetricTensors.T_1_3_A1()
+    T2 = SpatiallySymmetricTensors.T_1_3_A1_from_plain()
     _, ix = findmax(norm.(T1.data))
     λ = T1.data[ix] / T2.data[ix]
 
     @test norm(λ * T2 - T1) < 1e-12
 end
 
 @testset "test T_3_1_A1" begin
-    T1 = SpatiallySymmetricTensor.T_3_1_A1()
-    T2 = SpatiallySymmetricTensor.T_3_1_A1_from_plain()
+    T1 = SpatiallySymmetricTensors.T_3_1_A1()
+    T2 = SpatiallySymmetricTensors.T_3_1_A1_from_plain()
     _, ix = findmax(norm.(T1.data))
     λ = T1.data[ix] / T2.data[ix]
 
     @test norm(λ * T2 - T1) < 1e-12
 end
 
 @testset "spin exchange" begin 
-    Sleft, Sright = SpatiallySymmetricTensor.spin_exchange()
+    Sleft, Sright = SpatiallySymmetricTensors.spin_exchange()
     @tensor SdotS[-1 -2; -3 -4] := Sleft[-1; -3 1] * Sright[1 -2; -4]
     SdotS_arr1 = reshape(convert(Array, SdotS), (4, 4))