Skip to content

Commit 0ad6475

Browse files
lkdvoslkdvos
committed
Add Package
Update README
1 parent 071cbbc commit 0ad6475

24 files changed

+2447
-0
lines changed

‎.JuliaFormatter.toml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# See https://domluna.github.io/JuliaFormatter.jl/stable/ for a list of options
2+
style = "yas"

‎.github/dependabot.yml‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
2+
version: 2
3+
updates:
4+
- package-ecosystem: "github-actions"
5+
directory: "/" # Location of package manifests
6+
schedule:
7+
interval: "weekly"

‎.github/workflows/CI.yml‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
name: CI
2+
on:
3+
push:
4+
branches:
5+
- 'main'
6+
tags: ['*']
7+
pull_request:
8+
workflow_dispatch:
9+
10+
concurrency:
11+
group: ${{ github.workflow }}-${{ github.ref }}
12+
cancel-in-progress: ${{ startsWith(github.ref, 'refs/pull/') }}
13+
jobs:
14+
test:
15+
name: Julia ${{ matrix.version }} - ${{ matrix.os }} - ${{ matrix.arch }} - ${{ github.event_name }}
16+
runs-on: ${{ matrix.os }}
17+
timeout-minutes: 60
18+
permissions: # needed to allow julia-actions/cache to proactively delete old caches that it has created
19+
actions: write
20+
contents: read
21+
strategy:
22+
fail-fast: false
23+
matrix:
24+
version:
25+
- '1.10' # replace with LTS once it is released
26+
# - '1' # automatically expands to the latest stable 1.x release of Julia
27+
os:
28+
- ubuntu-latest
29+
- macOS-latest
30+
- windows-latest
31+
arch:
32+
- x64
33+
steps:
34+
- uses: actions/checkout@v4
35+
- uses: julia-actions/setup-julia@v2
36+
with:
37+
version: ${{ matrix.version }}
38+
arch: ${{ matrix.arch }}
39+
- uses: julia-actions/cache@v2
40+
- uses: julia-actions/julia-buildpkg@v1
41+
- uses: julia-actions/julia-runtest@v1
42+
- uses: julia-actions/julia-processcoverage@v1
43+
- uses: codecov/codecov-action@v4
44+
with:
45+
files: lcov.info
46+
token: ${{ secrets.CODECOV_TOKEN }}
47+
fail_ci_if_error: false

‎.github/workflows/CompatHelper.yml‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
name: CompatHelper
2+
on:
3+
schedule:
4+
- cron: 0 0 * * *
5+
workflow_dispatch:
6+
7+
jobs:
8+
CompatHelper:
9+
runs-on: ubuntu-latest
10+
steps:
11+
- name: Pkg.add("CompatHelper")
12+
run: julia -e 'using Pkg; Pkg.add("CompatHelper")'
13+
- name: CompatHelper.main()
14+
env:
15+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
16+
COMPATHELPER_PRIV: ${{ secrets.DOCUMENTER_KEY }}
17+
run: julia -e 'using CompatHelper; CompatHelper.main()'

‎.github/workflows/FormatCheck.yml‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
name: FormatCheck
2+
3+
on:
4+
push:
5+
branches:
6+
- 'main'
7+
- 'master'
8+
- 'release-'
9+
tags: '*'
10+
pull_request:
11+
12+
jobs:
13+
build:
14+
runs-on: ${{ matrix.os }}
15+
strategy:
16+
matrix:
17+
version:
18+
- '1' # automatically expands to the latest stable 1.x release of Julia
19+
os:
20+
- ubuntu-latest
21+
arch:
22+
- x64
23+
steps:
24+
- uses: julia-actions/setup-julia@latest
25+
with:
26+
version: ${{ matrix.version }}
27+
arch: ${{ matrix.arch }}
28+
29+
- uses: actions/checkout@v4
30+
- name: Install JuliaFormatter and format
31+
# This will use the latest version by default but you can set the version like so:
32+
#
33+
# julia -e 'using Pkg; Pkg.add(PackageSpec(name="JuliaFormatter", version="0.13.0"))'
34+
run: |
35+
julia -e 'using Pkg; Pkg.add(PackageSpec(name="JuliaFormatter"))'
36+
julia -e 'using JuliaFormatter; format(".", verbose=true)'
37+
- name: Format check
38+
run: |
39+
julia -e '
40+
out = Cmd(`git diff --name-only`) |> read |> String
41+
if out == ""
42+
exit(0)
43+
else
44+
@error "Some files have not been formatted !!!"
45+
write(stdout, out)
46+
exit(1)
47+
end'

‎.github/workflows/TagBot.yml‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
name: TagBot
2+
3+
on:
4+
issue_comment:
5+
types:
6+
- created
7+
workflow_dispatch:
8+
inputs:
9+
lookback:
10+
default: "3"
11+
12+
permissions:
13+
actions: read
14+
checks: read
15+
contents: write
16+
deployments: read
17+
issues: read
18+
discussions: read
19+
packages: read
20+
pages: read
21+
pull-requests: read
22+
repository-projects: read
23+
security-events: read
24+
statuses: read
25+
26+
jobs:
27+
TagBot:
28+
if: github.event_name == 'workflow_dispatch' || github.actor == 'JuliaTagBot'
29+
runs-on: ubuntu-latest
30+
steps:
31+
- uses: JuliaRegistries/TagBot@v1
32+
with:
33+
token: ${{ secrets.GITHUB_TOKEN }}
34+
ssh: ${{ secrets.DOCUMENTER_KEY }}

‎.gitignore‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
*.jl.*.cov
2+
*.jl.cov
3+
*.jl.mem
4+
/Manifest.toml

‎LICENSE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2024 Lukas Devos <lukas.devos@ugent.be>, Jutho Haegeman
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎Project.toml‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
name = "TensorKitSectors"
2+
uuid = "13a9c161-d5da-41f0-bcbd-e1a08ae0647f"
3+
authors = ["Lukas Devos", "Jutho Haegeman"]
4+
version = "0.1.0"
5+
6+
[deps]
7+
HalfIntegers = "f0d1745a-41c9-11e9-1dd9-e5d34d218721"
8+
LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
9+
TensorOperations = "6aa20fa7-93e2-5fca-9bc0-fbd0db3c71a2"
10+
WignerSymbols = "9f57e263-0b3d-5e2e-b1be-24f2bb48858b"
11+
12+
[compat]
13+
Aqua = "0.8"
14+
HalfIntegers = "1"
15+
JET = "0.9"
16+
julia = "1.10"
17+
LinearAlgebra = "1"
18+
Random = "1"
19+
Reexport = "1"
20+
TensorOperations = "5"
21+
Test = "1"
22+
TestExtras = "0.2"
23+
WignerSymbols = "1,2"
24+
25+
[extras]
26+
Aqua = "4c88cf16-eb10-579e-8560-4a9242c79595"
27+
JET = "c3a54625-cd67-489e-a8e7-0a5a0ff4e31b"
28+
Random = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c"
29+
Reexport = "189a3867-3050-52da-a836-e630ba90ab69"
30+
TensorOperations = "6aa20fa7-93e2-5fca-9bc0-fbd0db3c71a2"
31+
Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
32+
TestExtras = "5ed8adda-3752-4e41-b88a-e8b09835ee3a"
33+
34+
[targets]
35+
test = ["Aqua", "JET", "Test", "TestExtras", "TensorOperations", "Random", "Reexport"]

‎README.md‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# TensorKitSectors
2+
3+
A Julia package for working with objects in fusion categories.
4+
5+
| **Build Status** | **PkgEval** | **Coverage** | **Quality assurance** |
6+
|:----------------:|:------------:|:------------:|:---------------------:|
7+
| [![CI][ci-img]][ci-url] | [![PkgEval][pkgeval-img]][pkgeval-url] | [![Codecov][codecov-img]][codecov-url] | [![Aqua QA][aqua-img]][aqua-url] |
8+
9+
[ci-img]: https://github.com/QuantumKitHub/TensorKitSectors.jl/actions/workflows/CI.yml/badge.svg
10+
[ci-url]: https://github.com/QuantumKitHub/TensorKitSectors.jl/actions/workflows/CI.yml
11+
12+
[pkgeval-img]: https://JuliaCI.github.io/NanosoldierReports/pkgeval_badges/T/TensorKitSectors.svg
13+
[pkgeval-url]: https://JuliaCI.github.io/NanosoldierReports/pkgeval_badges/T/TensorKitSectors.html
14+
15+
[codecov-img]: https://codecov.io/gh/QuantumKitHub/TensorKitSectors.jl/branch/main/graph/badge.svg
16+
[codecov-url]: https://codecov.io/gh/QuantumKitHub/TensorKitSectors.jl
17+
18+
[aqua-img]: https://raw.githubusercontent.com/JuliaTesting/Aqua.jl/master/badge.svg
19+
[aqua-url]: https://github.com/JuliaTesting/Aqua.jl
20+
21+
This package provides functionality for defining objects in fusion categories, along with their topological data.
22+
This includes the fusion rules, the associators, and the braiding.
23+
In particular, this is the data that is needed to define (symmetric) tensors, which are defined over vector spaces graded by these objects.
24+
For the full functionality, we refer to [TensorKit.jl](https://github.com/Jutho/TensorKit.jl) and [its documentation](https://jutho.github.io/TensorKit.jl/latest/).
25+
26+
Install via the package manager.

0 commit comments

Comments
 (0)