ITensor / ITensor/ITensorNetworks.jl

Convenient constructors for tensor networks on grids

Open
#27 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Julia
Stars
128
Forks
23
Avg merge
4d 7h
Merged PRs (30d)
7

Description

Currently to make a tensor network on a grid (a finite MPS/PEPS) the interface is:

using NamedGraphs
using ITensorNetworks
s = siteinds("S=1/2", named_grid((2, 2)))
ψ = ITensorNetwork(s; link_space=4)

or without site indices:

ψ = ITensorNetwork(named_grid((2, 2)); link_space=4)

It would be convenient to have some shorthands like:

s = siteinds("S=1/2", (2, 2))
# s = siteinds("S=1/2", 2, 2)
ψ = ITensorNetwork(s; link_space=4)

or:

ITensorNetwork((2, 2); link_space=4)
# ITensorNetwork(2, 2; link_space=4)

The notation siteinds("S=1/2", 5) for making a path graph of length 5 will conflict with ITensors.jl notation so for now that one may have to be siteinds("S=1/2", (5,)). Additionally, we should allow functions like ITensorNetwork accept Vector{<:Index} which gets output by siteinds("S=1/2", 5), and in general allow Vector{<:Index} act like an IndsNetwork with linear integer vertex names, like Vector{ITensor} should act like an ITensorNetwork with linear integer vertex names.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by inspecting the existing ITensorNetwork, siteinds, IndsNetwork, and Vector-related constructors described in the issue. Add the requested grid shorthand forms and compatible vector behavior, then verify that tensor networks and site indices can be created for the shown grid and path examples without conflicting with ITensors.jl notation.

Written by the indexing model from the issue text.

Assessment

Tech stack
julia
Domain
backend
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.