Update for working with local registry

.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 }}

.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"

.github/workflows/LiterateCheck.yml

@@ -1,42 +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 once they are registered.
-          Pkg.add(url="https://github.com/ITensor/TypeParameterAccessors.jl")
-          Pkg.add(url="https://github.com/ITensor/UnspecifiedTypes.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

.github/workflows/Tests.yml

@@ -0,0 +1,39 @@
+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
+        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 }}

Project.toml

@@ -9,21 +9,26 @@ FillArrays = "1a297f60-69ca-5386-bcde-b61e274b549b"
 TypeParameterAccessors = "7e5a90cf-f82e-492e-a09b-e3e26432c138"
 UnspecifiedTypes = "42b3faec-625b-4613-8ddc-352bf9672b8d"
 
-[sources]
-TypeParameterAccessors = {url = "https://github.com/ITensor/TypeParameterAccessors.jl"}
-UnspecifiedTypes = {url = "https://github.com/ITensor/UnspecifiedTypes.jl"}
-
 [compat]
 Adapt = "4.1.1"
 Aqua = "0.8.9"
 FillArrays = "1.13.0"
+JLArrays = "0.2"
+NDTensors = "0.3"
+SafeTestsets = "0.1"
+Suppressor = "0.2"
 Test = "1.10"
+TypeParameterAccessors = "0.1.0"
 UnspecifiedTypes = "0.1.0"
 julia = "1.10"
 
 [extras]
 Aqua = "4c88cf16-eb10-579e-8560-4a9242c79595"
 Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
+SafeTestsets = "1bc83da4-3b8d-516f-aca4-4fe02f6d838f"
+Suppressor = "fd094767-a336-5f1f-9728-57cf17d0bbfb"
+JLArrays = "27aeb0d3-9eb9-45fb-866b-73c2ecf80fcb"
+NDTensors = "23ae76d9-e61a-49c4-8f12-3f1a16adf9cf"
 
 [targets]
-test = ["Aqua", "Test"]
+test = ["Aqua", "Test", "Suppressor", "SafeTestsets", "JLArrays", "NDTensors"]

README.md

@@ -2,7 +2,7 @@
 
 [![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://ITensor.github.io/UnallocatedArrays.jl/stable/)
 [![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://ITensor.github.io/UnallocatedArrays.jl/dev/)
-[![Build Status](https://github.com/ITensor/UnallocatedArrays.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/ITensor/UnallocatedArrays.jl/actions/workflows/CI.yml?query=branch%3Amain)
+[![Build Status](https://github.com/ITensor/UnallocatedArrays.jl/actions/workflows/Tests.yml/badge.svg?branch=main)](https://github.com/ITensor/UnallocatedArrays.jl/actions/workflows/Tests.yml?query=branch%3Amain)
 [![Coverage](https://codecov.io/gh/ITensor/UnallocatedArrays.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/ITensor/UnallocatedArrays.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)
@@ -12,14 +12,24 @@ tensors and allocating as little data as possible.
 
 ## 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/TypeParameterAccessors.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/UnspecifiedTypes.jl")
+Then, the package can be added as usual through the package manager:
 
-julia> Pkg.add(url="https://github.com/ITensor/UnallocatedArrays.jl")
+```julia
+julia> Pkg.add("UnallocatedArrays")
 ```
 
 ## Examples
@@ -28,8 +38,6 @@ julia> Pkg.add(url="https://github.com/ITensor/UnallocatedArrays.jl")
 using UnallocatedArrays: UnallocatedArrays
 ````
 
-Examples go here.
-
 ---
 
 *This page was generated using [Literate.jl](https://github.com/fredrikekre/Literate.jl).*

docs/Project.toml

@@ -4,7 +4,3 @@ Literate = "98b081ad-f1c9-55d3-8b20-4c87d4299306"
 TypeParameterAccessors = "7e5a90cf-f82e-492e-a09b-e3e26432c138"
 UnallocatedArrays = "43c9e47c-e622-40fb-bf18-a09fc8c466b6"
 UnspecifiedTypes = "42b3faec-625b-4613-8ddc-352bf9672b8d"
-
-[sources]
-TypeParameterAccessors = {url = "https://github.com/ITensor/TypeParameterAccessors.jl"}
-UnspecifiedTypes = {url = "https://github.com/ITensor/UnspecifiedTypes.jl"}

examples/Project.toml

@@ -2,7 +2,3 @@
 TypeParameterAccessors = "7e5a90cf-f82e-492e-a09b-e3e26432c138"
 UnallocatedArrays = "43c9e47c-e622-40fb-bf18-a09fc8c466b6"
 UnspecifiedTypes = "42b3faec-625b-4613-8ddc-352bf9672b8d"
-
-[sources]
-TypeParameterAccessors = {url = "https://github.com/ITensor/TypeParameterAccessors.jl"}
-UnspecifiedTypes = {url = "https://github.com/ITensor/UnspecifiedTypes.jl"}

examples/README.jl

@@ -2,7 +2,7 @@
 # 
 # [![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://ITensor.github.io/UnallocatedArrays.jl/stable/)
 # [![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://ITensor.github.io/UnallocatedArrays.jl/dev/)
-# [![Build Status](https://github.com/ITensor/UnallocatedArrays.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/ITensor/UnallocatedArrays.jl/actions/workflows/CI.yml?query=branch%3Amain)
+# [![Build Status](https://github.com/ITensor/UnallocatedArrays.jl/actions/workflows/Tests.yml/badge.svg?branch=main)](https://github.com/ITensor/UnallocatedArrays.jl/actions/workflows/Tests.yml?query=branch%3Amain)
 # [![Coverage](https://codecov.io/gh/ITensor/UnallocatedArrays.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/ITensor/UnallocatedArrays.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)
@@ -12,19 +12,32 @@
 
 # ## 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/TypeParameterAccessors.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/UnspecifiedTypes.jl")
+# Then, the package can be added as usual through the package manager:
 
-julia> Pkg.add(url="https://github.com/ITensor/UnallocatedArrays.jl")
+#=
+```julia
+julia> Pkg.add("UnallocatedArrays")
 ```
 =#
 
 # ## Examples
 
 using UnallocatedArrays: UnallocatedArrays
-# Examples go here.

src/abstractfill/abstractfill.jl

@@ -17,6 +17,9 @@ set_axestype(T::Type{<:AbstractFill}, ax::Type) = s(T, axestype, ax)
 
 TypeParameterAccessors.position(::Type{<:AbstractFill}, ::typeof(alloctype)) = Position(4)
 TypeParameterAccessors.position(::Type{<:AbstractFill}, ::typeof(axestype)) = Position(3)
+
+# this is type piracy (Aqua.jl complains) and should be moved to TypeParameterAccessors,
+# possibly via package extension
 function TypeParameterAccessors.default_type_parameters(::Type{<:AbstractFill})
   return (Float64, 0, Tuple{})
 end