docs: add the nscf band-structure record and a package install page - #56
Merged
Merged
Conversation
published-records.md gains the MC3D nscf band-structure dataset: what the three files hold, why metallicity uses a plain zero threshold, and how the k-point coordinates were reconstructed and on what evidence they were accepted. The record link is a placeholder until the PSDI draft is submitted and published. installation/ gains a page on installing goldilocks-data itself -- from a clone or as a git dependency, what the base install carries and why pymatgen is in it rather than in an extra, what each extra is actually for, and a snippet whose output shows the symmetry reduction ran. The installation overview becomes a router: most readers need the package alone, not the whole AiiDA and QE stack.
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
1 participant
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.
published-records.md gains the MC3D nscf band-structure dataset: what the three files hold, why metallicity uses a plain zero threshold, and how the k-point coordinates were reconstructed and on what evidence they were accepted. The record link is a placeholder until the PSDI draft is submitted and published.
installation/ gains a page on installing goldilocks-data itself -- from a clone or as a git dependency, what the base install carries and why pymatgen is in it rather than in an extra, what each extra is actually for, and a snippet whose output shows the symmetry reduction ran.
The installation overview becomes a router: most readers need the package alone, not the whole AiiDA and QE stack.