QuantumKitHub / MPSKitModels.jl

MIT License
15 stars 13 forks source link

Docs additions #12

Closed leburgel closed 7 months ago

leburgel commented 7 months ago

An attempt at improving consistency in spin and Pauli operator naming between the implementation and the documentation that got a little out of hand. Tried to:

I think all of the spinful fermion operators that take an up-down spin index also need an explicit docstring to be able to make sense of the Hubbard Hamiltonian, but I didn't try this (yet) since I'm not too sure about what's going on exactly.

codecov[bot] commented 7 months ago

Codecov Report

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

Comparison is base (cbc20b9) 50.00% compared to head (3b40cde) 52.00%. Report is 4 commits behind head on master.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #12 +/- ## ========================================== + Coverage 50.00% 52.00% +2.00% ========================================== Files 16 16 Lines 1272 1275 +3 ========================================== + Hits 636 663 +27 + Misses 636 612 -24 ```

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