Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs additions #12

Merged
merged 2 commits into from
Feb 13, 2024
Merged

Docs additions #12

merged 2 commits into from
Feb 13, 2024

Conversation

leburgel
Copy link
Member

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:

  • Systematically use Sⁱ for spin operators in model Hamiltonian docstrings. In particular, also introduced unicode aliases for these to be consistent with the model docstrings.
  • Systematically use a⁺ and a⁻ for bosonic creation operators, both in the definitions in the documentation and in the model Hamiltonian docstrings.
  • Systematically use e for spinful fermions.
  • Explicitly add all unicode aliases to the docstrings.

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.

Copy link
Member

@lkdvos lkdvos left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great, thanks!

Copy link

codecov bot commented Feb 13, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

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
@@            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     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@lkdvos lkdvos merged commit 55076c4 into QuantumKitHub:master Feb 13, 2024
11 checks passed
@leburgel leburgel deleted the docs_additions branch February 13, 2024 19:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants