ITensorPkgSkeleton.jl is supported by the Flatiron Institute, a division of the Simons Foundation.
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> using Pkg: Pkg
julia> Pkg.Registry.add(url = "https://github.com/ITensor/ITensorRegistry")or:
julia> Pkg.Registry.add(url = "git@github.com:ITensor/ITensorRegistry.git")if you want to use SSH credentials, which can make it so you don't have to enter your GitHub username and password when registering packages.
Then, the package can be added as usual through the package manager:
julia> Pkg.add("ITensorPkgSkeleton")using ITensorPkgSkeleton: ITensorPkgSkeleton
ITensorPkgSkeleton.generate("MyPackage")Examples go here.
The template/.github/workflows/ directory is the source of truth for the GitHub Actions
workflows shared across the ITensor ecosystem (Tests.yml, FormatCheck.yml, TagBot.yml,
CompatHelper.yml, etc.). Most of them simply call into reusable workflows in
ITensorActions; see that repository's README
for details on each.
TagBot.yml carries a marker env: REGISTRY_TAGBOT_ACTION: "JuliaRegistries/TagBot"
that looks unused but is required: the General registry's trigger workflow only treats
TagBot as enabled when the literal string JuliaRegistries/TagBot appears in a file
under .github/workflows/, and the reusable-workflow caller would otherwise not
contain it. The same string would work as a YAML comment, but
ITensorFormatter (itpkgfmt) strips
YAML comments via YAML.jl's writer (tracked
upstream at YAML.jl#245), so the
marker has to live in a structural element. See
ITensorActions's TagBot docs
for the full explanation. Do not remove this env: block.
This page was generated using Literate.jl.