-
Notifications
You must be signed in to change notification settings - Fork 2
Proofread Getting Started #3
Copy link
Copy link
Open
Labels
documentationIssue to be addressed by the documentation group.Issue to be addressed by the documentation group.
Description
Activity
Metadata
Metadata
Assignees
Labels
documentationIssue to be addressed by the documentation group.Issue to be addressed by the documentation group.
Projects
- StatusShow more project fieldsIn Progress
We need to finalize these tutorials to ensure they provide a professional and reliable introduction for new users. I have written these notebooks primarily to demonstrate the API's functionality, but they require a thorough technical review.
At the end of each notebook, I have calculated specific parameters to demonstrate that the code works; please verify these from a physics perspective to ensure the results are correct and the accompanying explanations are apt.
Target Notebooks
quickstart_tbg.ipynb(I checked this)k_space_hamiltonian.ipynbobc_vs_pbc.ipynbprepare_layers.ipynbcustom_hoppings.ipynbGuidelines
Please proofread for spelling, grammar, and general clarity, ensuring the explanations are concise. Keep the examples physically grounded but computationally simple so they run quickly during a live demonstration.