Skeleton update (#11)

ITensor · Dec 12, 2024 · 5bf6dab · 5bf6dab
1 parent 63bb180
commit 5bf6dab
Show file tree

Hide file tree

Showing 15 changed files with 189 additions and 220 deletions.
diff --git a/.github/workflows/CI.yml b/.github/workflows/CI.yml
diff --git a/.github/workflows/Documentation.yml b/.github/workflows/Documentation.yml
@@ -0,0 +1,23 @@
+name: "Documentation"
+
+on:
+  push:
+    branches:
+      - main
+    tags: '*'
+  pull_request:
+  schedule:
+    - cron: '1 4 * * 4'
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: ${{ github.ref_name != github.event.repository.default_branch || github.ref != 'refs/tags/v*' }}
+
+jobs:
+  build-and-deploy-docs:
+    name: "Documentation"
+    uses: "ITensor/ITensorActions/.github/workflows/Documentation.yml@main"
+    with:
+      localregistry: https://github.com/ITensor/ITensorRegistry.git
+    secrets:
+      CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
diff --git a/.github/workflows/FormatCheck.yml b/.github/workflows/FormatCheck.yml
@@ -1,35 +1,13 @@
-name: Format check
+name: "Format Check"
+
 on:
   push:
-    branches: [main]
-    tags: [v*]
+    branches:
+      - 'main'
+    tags: '*'
   pull_request:
 
 jobs:
-  format:
+  format-check:
     name: "Format Check"
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - uses: julia-actions/setup-julia@v2
-        with:
-          version: 1
-      - name: Install JuliaFormatter and format
-        run: |
-          julia  -e 'using Pkg; Pkg.add(PackageSpec(name="JuliaFormatter"))'
-          julia  -e 'using JuliaFormatter; format(".", verbose=true)'
-      - name: Check format
-        run: |
-          julia -e '
-          out = Cmd(`git diff --name-only`) |> read |> String
-          if out == ""
-              exit(0)
-          else
-              @error "The following files have not been formatted:"
-              write(stdout, out)
-              out_diff = Cmd(`git diff`) |> read |> String
-              @error "Diff:"
-              write(stdout, out_diff)
-              exit(1)
-              @error ""
-          end'
+    uses: "ITensor/ITensorActions/.github/workflows/FormatCheck.yml@main"
diff --git a/.github/workflows/LiterateCheck.yml b/.github/workflows/LiterateCheck.yml
@@ -1,47 +1,15 @@
-name: Literate check
+name: "Literate Check"
+
 on:
   push:
-    branches: [main]
-    tags: [v*]
+    branches:
+      - 'main'
+    tags: '*'
   pull_request:
 
 jobs:
   literate:
     name: "Literate Check"
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - uses: julia-actions/setup-julia@v2
-        with:
-          version: 1
-      - name: Install Literate and generate docs
-        run: |
-          julia  -e '
-          using Pkg
-          # TODO: Delete these once they are registered.
-          Pkg.add(url="https://github.com/ITensor/TypeParameterAccessors.jl")
-          Pkg.add(url="https://github.com/ITensor/BroadcastMapConversion.jl")
-          Pkg.add(url="https://github.com/ITensor/NestedPermutedDimsArrays.jl")
-          Pkg.add(url="https://github.com/ITensor/LabelledNumbers.jl")
-          Pkg.add(url="https://github.com/ITensor/GradedUnitRanges.jl")
-          Pkg.add(url="https://github.com/ITensor/SparseArraysBase.jl")
-          Pkg.add(url="https://github.com/ITensor/TensorAlgebra.jl")
-          Pkg.develop(PackageSpec(path=pwd()))
-          Pkg.instantiate()
-          Pkg.add(PackageSpec(name="Literate"))'
-          julia  -e 'include("docs/make_readme.jl")'
-      - name: Check if docs need to be updated
-        run: |
-          julia -e '
-          out = Cmd(`git diff --name-only`) |> read |> String
-          if out == ""
-              exit(0)
-          else
-              @error "The docs are outdated, rerun Literate to regenerate them."
-              write(stdout, out)
-              out_diff = Cmd(`git diff`) |> read |> String
-              @error "Diff:"
-              write(stdout, out_diff)
-              exit(1)
-              @error ""
-          end'
+    uses: "ITensor/ITensorActions/.github/workflows/LiterateCheck.yml@main"
+    with:
+      localregistry: https://github.com/ITensor/ITensorRegistry.git
diff --git a/.github/workflows/Tests.yml b/.github/workflows/Tests.yml
@@ -0,0 +1,42 @@
+name: Tests
+on:
+  push:
+    branches:
+      - 'master'
+      - 'main'
+      - 'release-'
+    tags: '*'
+    paths-ignore:
+      - 'docs/**'
+  pull_request:
+  workflow_dispatch:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  # Cancel intermediate builds: only if it is a pull request build.
+  cancel-in-progress: ${{ startsWith(github.ref, 'refs/pull/') }}
+
+jobs:
+  tests:
+    name: "Tests"
+    strategy:
+      fail-fast: false
+      matrix:
+        version:
+          - 'lts' # minimal supported version
+          - '1' # latest released Julia version
+        # group:
+        #   - 'core'
+        #   - 'optional'
+        os:
+          - ubuntu-latest
+          - macOS-latest
+          - windows-latest
+    uses: "ITensor/ITensorActions/.github/workflows/Tests.yml@main"
+    with:
+      group: "${{ matrix.group }}"
+      julia-version: "${{ matrix.version }}"
+      os: "${{ matrix.os }}"
+      localregistry: https://github.com/ITensor/ITensorRegistry.git
+    secrets:
+      CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -7,7 +7,8 @@ repos:
   - id: check-yaml
   - id: end-of-file-fixer
     exclude_types: [markdown]  # incompatible with Literate.jl
-- repo: https://github.com/qiaojunfeng/pre-commit-julia-format
-  rev: v0.2.0
+
+- repo: "https://github.com/domluna/JuliaFormatter.jl"
+  rev: v1.0.62  
   hooks:
-  - id: julia-format
+  - id: "julia-formatter"
diff --git a/Project.toml b/Project.toml
@@ -20,15 +20,6 @@ SplitApplyCombine = "03a91e81-4c3e-53e1-a0a4-9c0c8f19dd66"
 TensorAlgebra = "68bd88dc-f39d-4e12-b2ca-f046b68fcc6a"
 TypeParameterAccessors = "7e5a90cf-f82e-492e-a09b-e3e26432c138"
 
-[sources]
-BroadcastMapConversion = {url = "https://github.com/ITensor/BroadcastMapConversion.jl"}
-GradedUnitRanges = {url = "https://github.com/ITensor/GradedUnitRanges.jl"}
-LabelledNumbers = {url = "https://github.com/ITensor/LabelledNumbers.jl"}
-NestedPermutedDimsArrays = {url = "https://github.com/ITensor/NestedPermutedDimsArrays.jl"}
-SparseArraysBase = {url = "https://github.com/ITensor/SparseArraysBase.jl"}
-TensorAlgebra = {url = "https://github.com/ITensor/TensorAlgebra.jl"}
-TypeParameterAccessors = {url = "https://github.com/ITensor/TypeParameterAccessors.jl"}
-
 [compat]
 Adapt = "4.1.1"
 Aqua = "0.8.9"

diff --git a/README.md b/README.md
@@ -2,7 +2,7 @@
 
 [![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://ITensor.github.io/BlockSparseArrays.jl/stable/)
 [![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://ITensor.github.io/BlockSparseArrays.jl/dev/)
-[![Build Status](https://github.com/ITensor/BlockSparseArrays.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/ITensor/BlockSparseArrays.jl/actions/workflows/CI.yml?query=branch%3Amain)
+[![Build Status](https://github.com/ITensor/BlockSparseArrays.jl/actions/workflows/Tests.yml/badge.svg?branch=main)](https://github.com/ITensor/BlockSparseArrays.jl/actions/workflows/Tests.yml?query=branch%3Amain)
 [![Coverage](https://codecov.io/gh/ITensor/BlockSparseArrays.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/ITensor/BlockSparseArrays.jl)
 [![Code Style: Blue](https://img.shields.io/badge/code%20style-blue-4495d1.svg)](https://github.com/invenia/BlueStyle)
 [![Aqua](https://raw.githubusercontent.com/JuliaTesting/Aqua.jl/master/badge.svg)](https://github.com/JuliaTesting/Aqua.jl)
@@ -11,24 +11,24 @@ A block sparse array type in Julia based on the [`BlockArrays.jl`](https://githu
 
 ## Installation instructions
 
+This package resides in the `ITensor/ITensorRegistry` local registry.
+In order to install, simply add that registry through your package manager.
+This step is only required once.
 ```julia
 julia> using Pkg: Pkg
 
-julia> Pkg.add(url="https://github.com/ITensor/BroadcastMapConversion.jl")
-
-julia> Pkg.add(url="https://github.com/ITensor/NestedPermutedDimsArrays.jl")
-
-julia> Pkg.add(url="https://github.com/ITensor/TypeParameterAccessors.jl")
-
-julia> Pkg.add(url="https://github.com/ITensor/LabelledNumbers.jl")
-
-julia> Pkg.add(url="https://github.com/ITensor/GradedUnitRanges.jl")
-
-julia> Pkg.add(url="https://github.com/ITensor/SparseArraysBase.jl")
+julia> Pkg.Registry.add(url="https://github.com/ITensor/ITensorRegistry")
+```
+or:
+```julia
+julia> Pkg.Registry.add(url="[email protected]:ITensor/ITensorRegistry.git")
+```
+if you want to use SSH credentials, which can make it so you don't have to enter your Github ursername and password when registering packages.
 
-julia> Pkg.add(url="https://github.com/ITensor/TensorAlgebra.jl")
+Then, the package can be added as usual through the package manager:
 
-julia> Pkg.add(url="https://github.com/ITensor/BlockSparseArrays.jl")
+```julia
+julia> Pkg.add("BlockSparseArrays")
 ```
 
 ## Examples

diff --git a/docs/Project.toml b/docs/Project.toml
@@ -10,12 +10,3 @@ NestedPermutedDimsArrays = "2c2a8ec4-3cfc-4276-aa3e-1307b4294e58"
 SparseArraysBase = "0d5efcca-f356-4864-8770-e1ed8d78f208"
 TensorAlgebra = "68bd88dc-f39d-4e12-b2ca-f046b68fcc6a"
 TypeParameterAccessors = "7e5a90cf-f82e-492e-a09b-e3e26432c138"
-
-[sources]
-BroadcastMapConversion = {url = "https://github.com/ITensor/BroadcastMapConversion.jl"}
-GradedUnitRanges = {url = "https://github.com/ITensor/GradedUnitRanges.jl"}
-LabelledNumbers = {url = "https://github.com/ITensor/LabelledNumbers.jl"}
-NestedPermutedDimsArrays = {url = "https://github.com/ITensor/NestedPermutedDimsArrays.jl"}
-SparseArraysBase = {url = "https://github.com/ITensor/SparseArraysBase.jl"}
-TensorAlgebra = {url = "https://github.com/ITensor/TensorAlgebra.jl"}
-TypeParameterAccessors = {url = "https://github.com/ITensor/TypeParameterAccessors.jl"}
diff --git a/examples/Project.toml b/examples/Project.toml
@@ -11,12 +11,3 @@ SparseArraysBase = "0d5efcca-f356-4864-8770-e1ed8d78f208"
 TensorAlgebra = "68bd88dc-f39d-4e12-b2ca-f046b68fcc6a"
 Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
 TypeParameterAccessors = "7e5a90cf-f82e-492e-a09b-e3e26432c138"
-
-[sources]
-BroadcastMapConversion = {url = "https://github.com/ITensor/BroadcastMapConversion.jl"}
-GradedUnitRanges = {url = "https://github.com/ITensor/GradedUnitRanges.jl"}
-LabelledNumbers = {url = "https://github.com/ITensor/LabelledNumbers.jl"}
-NestedPermutedDimsArrays = {url = "https://github.com/ITensor/NestedPermutedDimsArrays.jl"}
-SparseArraysBase = {url = "https://github.com/ITensor/SparseArraysBase.jl"}
-TensorAlgebra = {url = "https://github.com/ITensor/TensorAlgebra.jl"}
-TypeParameterAccessors = {url = "https://github.com/ITensor/TypeParameterAccessors.jl"}
diff --git a/examples/README.jl b/examples/README.jl
@@ -2,7 +2,7 @@
 # 
 # [![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://ITensor.github.io/BlockSparseArrays.jl/stable/)
 # [![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://ITensor.github.io/BlockSparseArrays.jl/dev/)
-# [![Build Status](https://github.com/ITensor/BlockSparseArrays.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/ITensor/BlockSparseArrays.jl/actions/workflows/CI.yml?query=branch%3Amain)
+# [![Build Status](https://github.com/ITensor/BlockSparseArrays.jl/actions/workflows/Tests.yml/badge.svg?branch=main)](https://github.com/ITensor/BlockSparseArrays.jl/actions/workflows/Tests.yml?query=branch%3Amain)
 # [![Coverage](https://codecov.io/gh/ITensor/BlockSparseArrays.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/ITensor/BlockSparseArrays.jl)
 # [![Code Style: Blue](https://img.shields.io/badge/code%20style-blue-4495d1.svg)](https://github.com/invenia/BlueStyle)
 # [![Aqua](https://raw.githubusercontent.com/JuliaTesting/Aqua.jl/master/badge.svg)](https://github.com/JuliaTesting/Aqua.jl)
@@ -11,25 +11,29 @@
 
 # ## Installation instructions
 
+# This package resides in the `ITensor/ITensorRegistry` local registry.
+# In order to install, simply add that registry through your package manager.
+# This step is only required once.
 #=
 ```julia
 julia> using Pkg: Pkg
 
-julia> Pkg.add(url="https://github.com/ITensor/BroadcastMapConversion.jl")
-
-julia> Pkg.add(url="https://github.com/ITensor/NestedPermutedDimsArrays.jl")
-
-julia> Pkg.add(url="https://github.com/ITensor/TypeParameterAccessors.jl")
-
-julia> Pkg.add(url="https://github.com/ITensor/LabelledNumbers.jl")
-
-julia> Pkg.add(url="https://github.com/ITensor/GradedUnitRanges.jl")
-
-julia> Pkg.add(url="https://github.com/ITensor/SparseArraysBase.jl")
+julia> Pkg.Registry.add(url="https://github.com/ITensor/ITensorRegistry")
+```
+=#
+# or:
+#=
+```julia
+julia> Pkg.Registry.add(url="[email protected]:ITensor/ITensorRegistry.git")
+```
+=#
+# if you want to use SSH credentials, which can make it so you don't have to enter your Github ursername and password when registering packages.
 
-julia> Pkg.add(url="https://github.com/ITensor/TensorAlgebra.jl")
+# Then, the package can be added as usual through the package manager:
 
-julia> Pkg.add(url="https://github.com/ITensor/BlockSparseArrays.jl")
+#=
+```julia
+julia> Pkg.add("BlockSparseArrays")
 ```
 =#