ITensor / ITensorNetworks.jl

A package with general tools for working with higher-dimensional tensor networks based on ITensor.
MIT License
56 stars 12 forks source link

Name changes #154

Closed mtfishman closed 6 months ago

mtfishman commented 6 months ago

This changes TTN(...) to ttn(...) and randomITensorNetwork(...) to random_tensornetwork(...) (to be closer to random_mps and random_ttn).

@b-kloss this will probably be breaking for you. The reasoning for this is that we will likely get rid of the TTN type so ttn(...) is more "forward looking", i.e. in the future it can construct an ITensorNetwork. Additionally, randomITensorNetwork doesn't follow the naming convention in Julia that functions that aren't constructors should be all lower case.

EDIT: I also moved ising_network and Hamiltonian constructors like ising, heisenberg, etc. to submodules ModelNetworks and ModelHamiltonians, which is also breaking if those were being accessed with the notation ITensorsNetworks.ising or using ITensorsNetworks: ising. Now they should be accessed with using ITensorNetworks.ModelHamiltonians: ising or ITensorNetworks.ModelHamiltonians: ModelHamiltonians and ModelHamiltonians.ising.

codecov-commenter commented 6 months ago

Codecov Report

Attention: Patch coverage is 78.05907% with 52 lines in your changes are missing coverage. Please review.

Project coverage is 81.89%. Comparing base (c7f5e4b) to head (8845549). Report is 1 commits behind head on main.

Files Patch % Lines
src/treetensornetworks/opsum_to_ttn.jl 17.64% 14 Missing :warning:
src/ModelNetworks/ModelNetworks.jl 72.09% 12 Missing :warning:
src/mpo_mps_compatibility.jl 0.00% 8 Missing :warning:
src/approx_itensornetwork/approx_itensornetwork.jl 50.00% 6 Missing :warning:
src/treetensornetworks/ttn.jl 84.21% 6 Missing :warning:
src/ModelHamiltonians/ModelHamiltonians.jl 94.73% 5 Missing :warning:
src/boundarymps.jl 75.00% 1 Missing :warning:

:exclamation: Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #154 +/- ## ========================================== - Coverage 82.00% 81.89% -0.12% ========================================== Files 71 72 +1 Lines 3751 3744 -7 ========================================== - Hits 3076 3066 -10 - Misses 675 678 +3 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.