-
Notifications
You must be signed in to change notification settings - Fork 58
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
Disloc self_consistency bugfix & generalised kink mapping #266
Conversation
@@ -55,6 +55,9 @@ docs = [ | |||
cli = [ | |||
"argcomplete" | |||
] | |||
all = [ |
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.
Add to README/installation instructions in docs
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.
There doesn't seem to be an "installation" section of the built docs, and the README only lists the standard install (no optional deps), and the .[tests] target for running the unittests locally.
Is it worth adding a more detailed installation section to both in this PR? I can also see the advantage of adding a new .[dislocation] target to add atomman and ovito as optional deps at the same time, but this would require changing the default method for disloc CLE, and building in better error handling for missing imports (i.e. wrapping the import error in an error that says to pip install with the new .[dislocation] optional deps).
r_sc
parameter tobuild_cylinder
, enabling self-consistency only in a smaller region near coreskink_map
s (should be general for N cores)all
build target, to install test, docs, etc optional deps (pip install matscipy[all]
)