AmberInpcrdFile parses an AMBER inpcrd file and loads the data stored in it.
More...
|
| positions |
| The atom positions read from the inpcrd file.
|
|
| boxVectors |
| The periodic box vectors read from the inpcrd file.
|
|
| velocities |
| The atom velocities read from the inpcrd file.
|
|
AmberInpcrdFile parses an AMBER inpcrd file and loads the data stored in it.
def __init__ |
( |
|
self, |
|
|
|
file, |
|
|
|
loadVelocities = False , |
|
|
|
loadBoxVectors = False |
|
) |
| |
Load an inpcrd file.
An inpcrd file contains atom positions and, optionally, velocities and periodic box dimensions. Unfortunately, it is sometimes impossible to determine from the file itself exactly what data it contains. You therefore must specify in advance what data to load. It is stored into this object's "positions", "velocities", and "boxVectors" fields.
- Parameters
-
file | (string) the name of the file to load |
loadVelocities | (boolean=False) whether to load velocities from the file |
loadBoxVectors | (boolean=False) whether to load the periodic box vectors |
def getBoxVectors |
( |
|
self, |
|
|
|
asNumpy = False |
|
) |
| |
Get the periodic box vectors.
- Parameters
-
asNumpy | (boolean=False) if true, the values are returned as a numpy array instead of a list of Vec3s |
def getPositions |
( |
|
self, |
|
|
|
asNumpy = False |
|
) |
| |
Get the atomic positions.
- Parameters
-
asNumpy | (boolean=False) if true, the values are returned as a numpy array instead of a list of Vec3s |
def getVelocities |
( |
|
self, |
|
|
|
asNumpy = False |
|
) |
| |
Get the atomic velocities.
- Parameters
-
asNumpy | (boolean=False) if true, the vectors are returned as numpy arrays instead of Vec3s |
The periodic box vectors read from the inpcrd file.
The atom positions read from the inpcrd file.
The atom velocities read from the inpcrd file.
The documentation for this class was generated from the following file: