Redefine interface to get_wrapped_displacements
Description
The get_wrapped_displacements
is a function you use almost every day.
During the early days of hiphive we often had situations were had raw numpy arrays with positions and needed to wrap the displacements hence the signature is
get_wrapped_displacements(atoms.positions, atoms_ideal.positions, atoms_ideal.cell)
rather than
get_wrapped_displacements(atoms, atoms_ideal)
But these days I cant imagine calling this function without actually having corresponding atoms objects hence I suggest to change this interface to the latter. This change would break a lot of scripts but I think we should do it sooner rather than later.
Demo
- tests pass
- new code fully tested
- docstrings up to date and spelling error free
- rename to
get_displacements
?
Edited by Paul Erhart