-
Notifications
You must be signed in to change notification settings - Fork 139
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
Nexus: Add qdens-radial tool #3587
Conversation
Can one of the admins verify this patch? |
I plan to use this tool for my workshop labs. It would be ideal if it could be merged prior, if there are no issues. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please address comments below. Would be good to get a test + short manual entry for this, but this can wait until after the workshop session if time is tight.
nexus/bin/qdens-radial
Outdated
equiv_atoms = list(cd.info.structure.equivalent_atoms().keys()) | ||
|
||
if opt.species is not None and not set(opt.species).issubset(equiv_atoms): | ||
self.error('Input species (-S,--species) must be a subset of the species in the .xsf file.\nThe .xsf contains: {}\nYou provided: {}.'.format(equiv_atoms,opt.species.tolist())) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
-s
@mcbennet, just a couple more flag name find/replace and then this can go in. |
Thank you, @jtkrogel . I have addressed your latest comments |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Test this please |
Start testing in-house |
Proposed changes
This PR introduces the tool
qdens-radial
(name negotiable) into the Nexus collection of binaries. The tool calculates radial densities (or their integrals) around atomic sites given .xsf files containing density/spin-density data (tested for QE- and QMCPACK-generated densities). Key functionalities include:A usage is provided that describes how the tool is run:
Documentation should be added if this is merged. I can create an issue and assign myself and resolve it promptly after my workshop presentation.
What type(s) of changes does this code introduce?
Does this introduce a breaking change?
nxs-test
tests pass (I checked since I modifiednexus/lib/observables.py
slightly)What systems has this change been tested on?
Linux workstation
Checklist
Update the following with a yes where the items apply. If you're unsure about any of them, don't hesitate to ask. This is
simply a reminder of what we are going to look for before merging your code.