QuantumKitHub / MPSKit.jl

A Julia package dedicated to simulating quantum many-body systems using Matrix Product States (MPS)
MIT License
135 stars 30 forks source link

Update README.md #131

Closed v1j4y closed 7 months ago

v1j4y commented 7 months ago

Updated the verbosity=0 keyword argument to verbose=false to make the example run.

lkdvos commented 7 months ago

Thanks for noticing and fixing this! I am a bit confused by the InfiniteMPS not being exposed, as it really should be exported. see this line Am I missing something here? In any case, I really appreciate the help!

EDIT: I tried out the changes without explicitly calling MPSKit.InfiniteMPS, which worked for me.

codecov[bot] commented 7 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 83.09%. Comparing base (af3d352) to head (198cb54). Report is 1 commits behind head on master.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #131 +/- ## ======================================= Coverage 83.09% 83.09% ======================================= Files 70 70 Lines 4153 4153 ======================================= Hits 3451 3451 Misses 702 702 ```

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

lkdvos commented 7 months ago

I looked into this a bit more, and my apologies for the initial confusion.

I've been making some breaking changes to streamline the interface of MPSKit. In particular, I normalized the verbosity and verbose keywords to all be verbosity (See #125 ), as this is more in line with KrylovKit. However, there still are some breaking changes that I want to make before releasing a new version v0.11, in order to bundle all breaking changes in a single release. Thus, the master branch is a bit out of sync with the latest released version, so you'll have to bear with me for a bit. (Thus, the readme changes really are on purpose)

In any case, I apologize for the confusion and inconvenience, and hope to get this sorted ASAP.

v1j4y commented 7 months ago

Hello !

Thanks for the detailed reply.

I installed using ] add MPSKit (i.e. the latest version) which explains everything :slightly_smiling_face:

I'll close the PR since the issue was simply due to a change in the API which as you said will be updated soon.

All the best, Vijay