Merge branch 'dev' into main

kyungminlee · Jan 16, 2021 · 1473d86 · 1473d86
2 parents d451f41 + 01c13f0
commit 1473d86
Show file tree

Hide file tree

Showing 21 changed files with 245 additions and 97 deletions.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -0,0 +1,31 @@
+name: Build
+on: [push, pull_request]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: julia-actions/setup-julia@v1
+        with:
+          version: "1.5"
+      - name: Update registries
+        run: |
+          julia -e "using Pkg; Pkg.update()"
+          julia -e "using Pkg; Pkg.Registry.add(RegistrySpec(url=\"https://github.com/kyungminlee/KyungminLeeRegistry.jl.git\"))"
+          julia -e "using Pkg; Pkg.update()"
+      - name: Build packages
+        run: julia --project -e 'import Pkg; Pkg.build(); Pkg.precompile()'
+      - name: Run test with coverage
+        run: julia --project --check-bounds=yes -e 'import Pkg; Pkg.test(; coverage=true, julia_args=`--inline=no`)'
+        env:
+          JULIA_NUM_THREADS: "2"
+      - name: Submit coverage
+        run: |
+          julia -e 'using Pkg; Pkg.add("Coverage")'
+          julia -e 'using Coverage; Codecov.submit(Codecov.process_folder())'
+      - name: Documentation
+        run: |
+          julia --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()'
+          julia --project=docs/ docs/make.jl
+        env:
+          DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}
diff --git a/.travis.yml b/.travis.yml
diff --git a/Project.toml b/Project.toml
@@ -1,7 +1,7 @@
 name = "LatticeTools"
 uuid = "8a267902-5e0e-44c3-8ef8-9b2b5c352816"
 author = "Kyungmin Lee"
-version = "0.8.0"
+version = "0.8.1"
 
 [deps]
 FileIO = "5789e2e9-d7fb-5bc7-8068-2c6fae9b9549"

diff --git a/README.md b/README.md
@@ -4,7 +4,7 @@
 
 | **Documentation** | **Build Status** | **Code Coverage** |
 |:-----------------:|:----------------:|:-----------------:|
-| [![**STABLE**][docs-stable-img]][docs-stable-url] [![**DEV**][docs-dev-img]][docs-dev-url] | [![Build Status][travis-img]][travis-url] [![Build Status][appveyor-img]][appveyor-url] | [![Code Coverage][codecov-img]][codecov-url] [![Code Coverage][coveralls-img]][coveralls-url] |
+| [![**STABLE**][docs-stable-img]][docs-stable-url] [![**DEV**][docs-dev-img]][docs-dev-url] | [![Build][githubaction-img]][githubaction-url] | [![Code Coverage][codecov-img]][codecov-url] |
 
 [LatticeTools.jl](https://github.com/kyungminlee/LatticeTools.jl) is a Julia package that provides functionalities to define lattices and perform symmetry analyses useful for studying interacting quantum many-body Hamiltonians.
 
@@ -23,14 +23,8 @@
 [docs-dev-img]: https://img.shields.io/badge/docs-dev-blue.svg
 [docs-dev-url]: https://kyungminlee.org/LatticeTools.jl/dev
 
-[travis-img]: https://travis-ci.org/kyungminlee/LatticeTools.jl.svg?branch=master
-[travis-url]: https://travis-ci.org/kyungminlee/LatticeTools.jl
-
-[appveyor-img]: https://ci.appveyor.com/api/projects/status/1yrosfyjvn4u61nw?svg=true
-[appveyor-url]: https://ci.appveyor.com/project/kyungminlee/LatticeTools-jl
+[githubaction-img]: https://github.com/kyungminlee/LatticeTools.jl/workflows/Build/badge.svg
+[githubaction-url]: https://github.com/kyungminlee/LatticeTools.jl/actions?query=workflow%3ABuild
 
 [codecov-img]: https://codecov.io/gh/kyungminlee/LatticeTools.jl/branch/master/graph/badge.svg
 [codecov-url]: https://codecov.io/gh/kyungminlee/LatticeTools.jl
-
-[coveralls-img]: https://coveralls.io/repos/github/kyungminlee/LatticeTools.jl/badge.svg?branch=master
-[coveralls-url]: https://coveralls.io/github/kyungminlee/LatticeTools.jl?branch=master
diff --git a/appveyor.yml b/appveyor.yml
diff --git a/docs/make.jl b/docs/make.jl
@@ -57,7 +57,7 @@ makedocs(
     ]
 )
 
-deploydocs(
-    repo = "github.com/kyungminlee/LatticeTools.jl.git",
-    devbranch = "dev",
+deploydocs(;
+    repo="github.com/kyungminlee/LatticeTools.jl.git",
+    devbranch="dev",
 )
diff --git a/docs/src/assets/logo.png b/docs/src/assets/logo.png
diff --git a/docs/src/assets/logo.svg b/docs/src/assets/logo.svg
diff --git a/logo/make.jl b/logo/make.jl
@@ -17,7 +17,7 @@ end
 site_coordinates = hcat(site_coordinates...)
 site_coordinates[2,:] = -site_coordinates[2,:]
 
-Drawing(800, 300, "logo.png")
+Drawing(800, 300, "logo.svg")
 
 origin()
 translate(-450, 130)

diff --git a/src/Basic/hypercube.jl b/src/Basic/hypercube.jl
@@ -6,6 +6,7 @@ export isequiv
 
 import MathExpr
 
+
 """
     Hypercube(shape)
 
@@ -42,13 +43,15 @@ struct Hypercube
     end
 end
 
+
 """
     dimension(cube::Hypercube)
 
 Return the spatial dimension of the hypercube.
 """
 dimension(cube::Hypercube) = size(cube.shape_matrix, 1)
 
+
 """
     volume(cube::Hypercube)
 

diff --git a/src/Basic/unitcell.jl b/src/Basic/unitcell.jl
@@ -427,14 +427,6 @@ function whichunitcell(
 end
 
 
-#=
-function zero(uc::UnitCell; dtype::DataType=ComplexF64)
-    norb = numsite(uc)
-    return Base.zeros(dtype, (norb, norb))
-end
-=#
-
-
 """
     momentumgrid(unitcell, shape)
 

diff --git a/src/Group/permutation.jl b/src/Group/permutation.jl
@@ -4,6 +4,7 @@ export Permutation
 export generate_group
 export isidentity
 
+
 """
     Permutation(perms; max_order=2048)
 

diff --git a/src/Irrep/irrep.jl b/src/Irrep/irrep.jl
@@ -8,6 +8,7 @@ export get_irrep_components
 export get_irrep_iterator
 export little_symmetry
 
+
 struct IrrepData
     group::FiniteGroup
     conjugacy_classes::Vector{Vector{Int}}
@@ -68,6 +69,7 @@ function Base.:(==)(lhs::IrrepComponent, rhs::IrrepComponent)
     )
 end
 
+
 """
     group_order(sic::IrrepComponent)
 

diff --git a/src/LatticeTools.jl b/src/LatticeTools.jl
@@ -14,7 +14,6 @@ include("SymmetryOperation/identityoperation.jl")
 include("SymmetryOperation/translationoperation.jl")
 include("SymmetryOperation/pointoperation.jl")
 include("SymmetryOperation/spaceoperation.jl")
-# include("SymmetryOperation/productoperation.jl")
 
 include("Symmetry/abstractsymmetry.jl")
 include("Symmetry/translationsymmetry.jl")

diff --git a/src/Symmetry/abstractsymmetry.jl b/src/Symmetry/abstractsymmetry.jl
@@ -1,10 +1,8 @@
 export AbstractSymmetry
-# export AbstractUnitSymmetry
 
 """
     AbstractSymmetry{OperationType<:AbstractSpaceSymmetryOperation}
 
 Abstract symmetry whose elements are of type `OperationType`.
 """
 abstract type AbstractSymmetry{OperationType<:AbstractSpaceSymmetryOperation} end
-# abstract type AbstractUnitSymmetry{OperationType<:AbstractSpaceSymmetryOperation} <: AbstractSymmetry{OperationType} end
diff --git a/src/Symmetry/pointsymmetrydatabase.jl b/src/Symmetry/pointsymmetrydatabase.jl
@@ -9,8 +9,6 @@ import Serialization
 import Pkg
 
 using YAML
-using JLD2
-using FileIO
 
 import ..LatticeTools: PointSymmetry, read_point_symmetry, simplify_name
 

diff --git a/src/SymmetryEmbedding/sitemap.jl b/src/SymmetryEmbedding/sitemap.jl
@@ -3,6 +3,7 @@ export findorbitalmap
 
 @deprecate findorbitalmap(args...) findsitemap(args...)
 
+
 """
     findsitemap(unitcell, translation_operation)
 

diff --git a/src/SymmetryEmbedding/sitepermutation.jl b/src/SymmetryEmbedding/sitepermutation.jl
@@ -6,9 +6,11 @@ export SitePermutation
 export embed
 export isidentity
 
+
 abstract type AbstractSymmetryOperationEmbedding end
 abstract type AbstractSpaceSymmetryOperationEmbedding <: AbstractSymmetryOperationEmbedding end
 
+
 """
     SitePermutation
 

diff --git a/src/SymmetryEmbedding/symmetryembedding.jl b/src/SymmetryEmbedding/symmetryembedding.jl
@@ -1,7 +1,6 @@
 export AbstractSymmetryEmbedding
 
 export SymmetryEmbedding
-# export SymmorphicSpaceSymmetryEmbedding
 
 export embed
 export element, elements

diff --git a/src/SymmetryOperation/abstractoperation.jl b/src/SymmetryOperation/abstractoperation.jl
@@ -1,13 +1,16 @@
+export AbstractSymmetryOperation
 export AbstractSpaceSymmetryOperation
 export domaintype
 
+abstract type AbstractSymmetryOperation end
+
 """
     AbstractSpaceSymmetryOperation{S<:Real}
 
 Abstract space symmetry operation, i.e. translation, point, and space operation.
 See also [`TranslationOperation`](@ref), [`PointOperation`](@ref), [`SpaceOperation`](@ref).
 """
-abstract type AbstractSpaceSymmetryOperation{S<:Real} end
+abstract type AbstractSpaceSymmetryOperation{S<:Real} <: AbstractSymmetryOperation end
 
 """
     domaintype(arg::AbstractSpaceSymmetryOperation{S}) where {S<:Real}

diff --git a/src/momentumpath.jl b/src/momentumpath.jl
@@ -34,13 +34,15 @@ function linpath(anchors::AbstractVector...; nseg::Integer=100)
     return out
 end
 
-# """
-#     momentumpath
-#
-# The anchorpoints are given in units of the reciprocal lattice vectors.
-# """
-# function momentumpath(unitcell::UnitCell,
-#                       anchors::AbstractVector{<:AbstractVector{<:Number}})
-#     real_anchorpoints = [unitcell.reciprocallatticevectors * ap for ap in anchorpoints]
-#     return linpath(real_anchorpoints...)
-# end
+"""
+    momentumpath
+
+The anchorpoints are given in units of the reciprocal lattice vectors.
+"""
+function momentumpath(
+    unitcell::UnitCell,
+    anchorpoints::AbstractVector{<:AbstractVector{<:Number}},
+)
+    real_anchorpoints = [unitcell.reciprocallatticevectors * ap for ap in anchorpoints]
+    return linpath(real_anchorpoints...)
+end
-Original file line number
+Diff line change
@@ Expand Up / @@ -4,6 +4,7 @@ export Permutation @@
     export generate_group
     export isidentity
     """
         Permutation(perms; max_order=2048)
@@ Expand Down @@
Original file line number	Diff line number	Diff line change
Expand Up		@@ -3,6 +3,7 @@ export findorbitalmap

		@deprecate findorbitalmap(args...) findsitemap(args...)


		"""
		findsitemap(unitcell, translation_operation)

Expand Down