Skip to content
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

calc_minimize convergence values changed and function doc stringed. #261

Merged
merged 3 commits into from
Jul 16, 2019

Conversation

raynol-dsouza
Copy link
Contributor

calc_minimize convergence values changed and function doc stringed.

@coveralls
Copy link

Pull Request Test Coverage Report for Build 1716

  • 2 of 2 (100.0%) changed or added relevant lines in 2 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 69.423%

Totals Coverage Status
Change from base Build 1689: 0.0%
Covered Lines: 12149
Relevant Lines: 17500

💛 - Coveralls

@liamhuber
Copy link
Member

liamhuber commented Jul 12, 2019

  1. Git subtlety: please merge in Uday's changes so that this pull is just for this pull. (I merged his pull, so it should be as simple as merging the master into this branch.)

  2. I'd like some more clarity in the doc strings.

  • Especially, what does 'convergence criterion' mean? For energy I guess it's just magnitude of the difference from one step to the next, but maybe I'm wrong. For forces, is it the max force magnitude among all atoms? Is it the magnitude of the N_atoms x 3 force vector?
  • Pressure default should explicitly indicate that 'None' means constant volume (aka isochoric) calculation will be used.
  • Also, the pressure units are usually eV / ang^3, but I guess somewhere there's a place to change pyiron units and there's some way for the user to change this, in which case we try to avoid hard-coding units into the docstrings. (I'm sure I'm guilty of doing this too!) @jan-janssen, can you comment about this possibility of unit changing?
  • Finally, and pretty minorly, I would appreciate some more explicit description of what "printing" or "dumping" is. In particular, I guess "dump" is a phrase which will be very informative to Lammps users, but might not be so helpful for people coming from a Vasp background.

@liamhuber liamhuber merged commit e987a18 into master Jul 16, 2019
@liamhuber liamhuber deleted the minimized_defaults branch July 16, 2019 13:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants