Skip to content

Commit 5bf6dab

Browse files
mtfishmanmtfishman
authored
Skeleton update (#11)
1 parent 63bb180 commit 5bf6dab

File tree

15 files changed

+189
-220
lines changed

15 files changed

+189
-220
lines changed

‎.github/workflows/CI.yml

Lines changed: 0 additions & 79 deletions
This file was deleted.

‎.github/workflows/Documentation.yml

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
name: "Documentation"
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
tags: '*'
8+
pull_request:
9+
schedule:
10+
- cron: '1 4 * * 4'
11+
12+
concurrency:
13+
group: ${{ github.workflow }}-${{ github.ref }}
14+
cancel-in-progress: ${{ github.ref_name != github.event.repository.default_branch || github.ref != 'refs/tags/v*' }}
15+
16+
jobs:
17+
build-and-deploy-docs:
18+
name: "Documentation"
19+
uses: "ITensor/ITensorActions/.github/workflows/Documentation.yml@main"
20+
with:
21+
localregistry: https://github.com/ITensor/ITensorRegistry.git
22+
secrets:
23+
CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

‎.github/workflows/FormatCheck.yml

Lines changed: 7 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,13 @@
1-
name: Format check
1+
name: "Format Check"
2+
23
on:
34
push:
4-
branches: [main]
5-
tags: [v*]
5+
branches:
6+
- 'main'
7+
tags: '*'
68
pull_request:
79

810
jobs:
9-
format:
11+
format-check:
1012
name: "Format Check"
11-
runs-on: ubuntu-latest
12-
steps:
13-
- uses: actions/checkout@v4
14-
- uses: julia-actions/setup-julia@v2
15-
with:
16-
version: 1
17-
- name: Install JuliaFormatter and format
18-
run: |
19-
julia -e 'using Pkg; Pkg.add(PackageSpec(name="JuliaFormatter"))'
20-
julia -e 'using JuliaFormatter; format(".", verbose=true)'
21-
- name: Check format
22-
run: |
23-
julia -e '
24-
out = Cmd(`git diff --name-only`) |> read |> String
25-
if out == ""
26-
exit(0)
27-
else
28-
@error "The following files have not been formatted:"
29-
write(stdout, out)
30-
out_diff = Cmd(`git diff`) |> read |> String
31-
@error "Diff:"
32-
write(stdout, out_diff)
33-
exit(1)
34-
@error ""
35-
end'
13+
uses: "ITensor/ITensorActions/.github/workflows/FormatCheck.yml@main"

‎.github/workflows/LiterateCheck.yml

Lines changed: 8 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,15 @@
1-
name: Literate check
1+
name: "Literate Check"
2+
23
on:
34
push:
4-
branches: [main]
5-
tags: [v*]
5+
branches:
6+
- 'main'
7+
tags: '*'
68
pull_request:
79

810
jobs:
911
literate:
1012
name: "Literate Check"
11-
runs-on: ubuntu-latest
12-
steps:
13-
- uses: actions/checkout@v4
14-
- uses: julia-actions/setup-julia@v2
15-
with:
16-
version: 1
17-
- name: Install Literate and generate docs
18-
run: |
19-
julia -e '
20-
using Pkg
21-
# TODO: Delete these once they are registered.
22-
Pkg.add(url="https://github.com/ITensor/TypeParameterAccessors.jl")
23-
Pkg.add(url="https://github.com/ITensor/BroadcastMapConversion.jl")
24-
Pkg.add(url="https://github.com/ITensor/NestedPermutedDimsArrays.jl")
25-
Pkg.add(url="https://github.com/ITensor/LabelledNumbers.jl")
26-
Pkg.add(url="https://github.com/ITensor/GradedUnitRanges.jl")
27-
Pkg.add(url="https://github.com/ITensor/SparseArraysBase.jl")
28-
Pkg.add(url="https://github.com/ITensor/TensorAlgebra.jl")
29-
Pkg.develop(PackageSpec(path=pwd()))
30-
Pkg.instantiate()
31-
Pkg.add(PackageSpec(name="Literate"))'
32-
julia -e 'include("docs/make_readme.jl")'
33-
- name: Check if docs need to be updated
34-
run: |
35-
julia -e '
36-
out = Cmd(`git diff --name-only`) |> read |> String
37-
if out == ""
38-
exit(0)
39-
else
40-
@error "The docs are outdated, rerun Literate to regenerate them."
41-
write(stdout, out)
42-
out_diff = Cmd(`git diff`) |> read |> String
43-
@error "Diff:"
44-
write(stdout, out_diff)
45-
exit(1)
46-
@error ""
47-
end'
13+
uses: "ITensor/ITensorActions/.github/workflows/LiterateCheck.yml@main"
14+
with:
15+
localregistry: https://github.com/ITensor/ITensorRegistry.git

‎.github/workflows/Tests.yml

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
name: Tests
2+
on:
3+
push:
4+
branches:
5+
- 'master'
6+
- 'main'
7+
- 'release-'
8+
tags: '*'
9+
paths-ignore:
10+
- 'docs/**'
11+
pull_request:
12+
workflow_dispatch:
13+
14+
concurrency:
15+
group: ${{ github.workflow }}-${{ github.ref }}
16+
# Cancel intermediate builds: only if it is a pull request build.
17+
cancel-in-progress: ${{ startsWith(github.ref, 'refs/pull/') }}
18+
19+
jobs:
20+
tests:
21+
name: "Tests"
22+
strategy:
23+
fail-fast: false
24+
matrix:
25+
version:
26+
- 'lts' # minimal supported version
27+
- '1' # latest released Julia version
28+
# group:
29+
# - 'core'
30+
# - 'optional'
31+
os:
32+
- ubuntu-latest
33+
- macOS-latest
34+
- windows-latest
35+
uses: "ITensor/ITensorActions/.github/workflows/Tests.yml@main"
36+
with:
37+
group: "${{ matrix.group }}"
38+
julia-version: "${{ matrix.version }}"
39+
os: "${{ matrix.os }}"
40+
localregistry: https://github.com/ITensor/ITensorRegistry.git
41+
secrets:
42+
CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

‎.pre-commit-config.yaml

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,8 @@ repos:
77
- id: check-yaml
88
- id: end-of-file-fixer
99
exclude_types: [markdown] # incompatible with Literate.jl
10-
- repo: https://github.com/qiaojunfeng/pre-commit-julia-format
11-
rev: v0.2.0
10+
11+
- repo: "https://github.com/domluna/JuliaFormatter.jl"
12+
rev: v1.0.62
1213
hooks:
13-
- id: julia-format
14+
- id: "julia-formatter"

‎Project.toml

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -20,15 +20,6 @@ SplitApplyCombine = "03a91e81-4c3e-53e1-a0a4-9c0c8f19dd66"
2020
TensorAlgebra = "68bd88dc-f39d-4e12-b2ca-f046b68fcc6a"
2121
TypeParameterAccessors = "7e5a90cf-f82e-492e-a09b-e3e26432c138"
2222

23-
[sources]
24-
BroadcastMapConversion = {url = "https://github.com/ITensor/BroadcastMapConversion.jl"}
25-
GradedUnitRanges = {url = "https://github.com/ITensor/GradedUnitRanges.jl"}
26-
LabelledNumbers = {url = "https://github.com/ITensor/LabelledNumbers.jl"}
27-
NestedPermutedDimsArrays = {url = "https://github.com/ITensor/NestedPermutedDimsArrays.jl"}
28-
SparseArraysBase = {url = "https://github.com/ITensor/SparseArraysBase.jl"}
29-
TensorAlgebra = {url = "https://github.com/ITensor/TensorAlgebra.jl"}
30-
TypeParameterAccessors = {url = "https://github.com/ITensor/TypeParameterAccessors.jl"}
31-
3223
[compat]
3324
Adapt = "4.1.1"
3425
Aqua = "0.8.9"

‎README.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://ITensor.github.io/BlockSparseArrays.jl/stable/)
44
[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://ITensor.github.io/BlockSparseArrays.jl/dev/)
5-
[![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)
5+
[![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)
66
[![Coverage](https://codecov.io/gh/ITensor/BlockSparseArrays.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/ITensor/BlockSparseArrays.jl)
77
[![Code Style: Blue](https://img.shields.io/badge/code%20style-blue-4495d1.svg)](https://github.com/invenia/BlueStyle)
88
[![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
1111

1212
## Installation instructions
1313

14+
This package resides in the `ITensor/ITensorRegistry` local registry.
15+
In order to install, simply add that registry through your package manager.
16+
This step is only required once.
1417
```julia
1518
julia> using Pkg: Pkg
1619

17-
julia> Pkg.add(url="https://github.com/ITensor/BroadcastMapConversion.jl")
18-
19-
julia> Pkg.add(url="https://github.com/ITensor/NestedPermutedDimsArrays.jl")
20-
21-
julia> Pkg.add(url="https://github.com/ITensor/TypeParameterAccessors.jl")
22-
23-
julia> Pkg.add(url="https://github.com/ITensor/LabelledNumbers.jl")
24-
25-
julia> Pkg.add(url="https://github.com/ITensor/GradedUnitRanges.jl")
26-
27-
julia> Pkg.add(url="https://github.com/ITensor/SparseArraysBase.jl")
20+
julia> Pkg.Registry.add(url="https://github.com/ITensor/ITensorRegistry")
21+
```
22+
or:
23+
```julia
24+
julia> Pkg.Registry.add(url="[email protected]:ITensor/ITensorRegistry.git")
25+
```
26+
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.
2827

29-
julia> Pkg.add(url="https://github.com/ITensor/TensorAlgebra.jl")
28+
Then, the package can be added as usual through the package manager:
3029

31-
julia> Pkg.add(url="https://github.com/ITensor/BlockSparseArrays.jl")
30+
```julia
31+
julia> Pkg.add("BlockSparseArrays")
3232
```
3333

3434
## Examples

‎docs/Project.toml

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,3 @@ NestedPermutedDimsArrays = "2c2a8ec4-3cfc-4276-aa3e-1307b4294e58"
1010
SparseArraysBase = "0d5efcca-f356-4864-8770-e1ed8d78f208"
1111
TensorAlgebra = "68bd88dc-f39d-4e12-b2ca-f046b68fcc6a"
1212
TypeParameterAccessors = "7e5a90cf-f82e-492e-a09b-e3e26432c138"
13-
14-
[sources]
15-
BroadcastMapConversion = {url = "https://github.com/ITensor/BroadcastMapConversion.jl"}
16-
GradedUnitRanges = {url = "https://github.com/ITensor/GradedUnitRanges.jl"}
17-
LabelledNumbers = {url = "https://github.com/ITensor/LabelledNumbers.jl"}
18-
NestedPermutedDimsArrays = {url = "https://github.com/ITensor/NestedPermutedDimsArrays.jl"}
19-
SparseArraysBase = {url = "https://github.com/ITensor/SparseArraysBase.jl"}
20-
TensorAlgebra = {url = "https://github.com/ITensor/TensorAlgebra.jl"}
21-
TypeParameterAccessors = {url = "https://github.com/ITensor/TypeParameterAccessors.jl"}

‎examples/Project.toml

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,3 @@ SparseArraysBase = "0d5efcca-f356-4864-8770-e1ed8d78f208"
1111
TensorAlgebra = "68bd88dc-f39d-4e12-b2ca-f046b68fcc6a"
1212
Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
1313
TypeParameterAccessors = "7e5a90cf-f82e-492e-a09b-e3e26432c138"
14-
15-
[sources]
16-
BroadcastMapConversion = {url = "https://github.com/ITensor/BroadcastMapConversion.jl"}
17-
GradedUnitRanges = {url = "https://github.com/ITensor/GradedUnitRanges.jl"}
18-
LabelledNumbers = {url = "https://github.com/ITensor/LabelledNumbers.jl"}
19-
NestedPermutedDimsArrays = {url = "https://github.com/ITensor/NestedPermutedDimsArrays.jl"}
20-
SparseArraysBase = {url = "https://github.com/ITensor/SparseArraysBase.jl"}
21-
TensorAlgebra = {url = "https://github.com/ITensor/TensorAlgebra.jl"}
22-
TypeParameterAccessors = {url = "https://github.com/ITensor/TypeParameterAccessors.jl"}

0 commit comments

Comments
 (0)