DOC: Conventional variable names (atoms, images, fd etc.)
Suggested by @askhl in !2371 (merged) , there are some "standard" variable names that we use consistently to make code more greppable and easier to interpret. We could provide a table of these in the "Coding Conventions" documentation.
Some that were suggested by Ask or otherwise immediately come to mind are
class | conventional name | Notes |
---|---|---|
Atoms | atoms | |
[Atoms, Atoms, ...] | images | Somewhat ambiguous relationship with traj
|
Calculator | calc | |
Optimizer | opt | |
MolecularDynamics | dyn | |
Trajectory | traj | |
Vibrations | vib | |
matplotlib.axes.Axes | ax | |
np.random.RandomState | rng | |
Files or StringIO | fd | Usually in the form with open(filename) as fd: ...
|