Merged
Conversation
Contributor
Author
|
Included function to plots the interactions bonds in OpSum() |
awietek
requested changes
Mar 31, 2025
Owner
awietek
left a comment
There was a problem hiding this comment.
Thank you Rafael, this looks great. I would have one comment about naming conventions. I would like to stick to CamelCase for classes, e.g. OpSum, and snake_case for functions. Thus, I would like to ask you to rename:
plotOpSum -> plot_opsum
write_OpSum_to_toml -> write_opsum_to_toml
plotops -> plot_ops
Also, I would like to ask you to add a "docstring" explaining the functions and parameters. I think it would be great if this showed up in the documentation.
Anyway, great work.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request introduces the following changes:
Renamed
bonds.jltoopsum.jlOpand collect them all in anOpSum.Modified and tested the functions
neighbor_bonds!andlattice_bondsOpSum().Added
write_OpSum_to_toml!functionalityindex_zeroargument to enable zero-based indexing for site indices when writing to a TOML file.Created an
examplesfolder with two scriptsAdded inline comments and documentation