mdtraj.NetCDFTrajectoryFile

class mdtraj.NetCDFTrajectoryFile(filename, mode='r', force_overwrite=True)

Interface for reading and writing to AMBER NetCDF files. This is a file-like object, that both reading or writing depending on the mode flag. It implements the context manager protocol, so you can also use it with the python ‘with’ statement.

Parameters:

filename : str

The name of the file to open

mode : {‘r’, ‘w’, ‘a’, ‘ws’, ‘as’}, default=’r’

The mode in which to open the file. Valid options are ‘r’, ‘w’, and ‘a’ for ‘read’, ‘write’, and ‘append’ respectively. The modes ‘w’ and ‘a’ may also be prefixed with ‘s’ which turns off buffering.

force_overwrite : bool, default=False

In write mode, if a file named filename already exists, clobber it and overwrite it.
__init__(filename, mode='r', force_overwrite=True)

Methods

__init__(filename[, mode, force_overwrite])
close() Close the NetCDF file handle
flush() Write all buffered data in the to the disk file.
read([n_frames, stride, atom_indices]) Read data from a molecular dynamics trajectory in the AMBER NetCDF format.
seek(offset[, whence]) Move to a new file position
tell() Current file position
write(coordinates[, time, cell_lengths, ...]) Write one or more frames of a molecular dynamics trajectory to disk in the AMBER NetCDF format.

Attributes

distance_unit
n_atoms
n_frames
read(n_frames=None, stride=None, atom_indices=None)

Read data from a molecular dynamics trajectory in the AMBER NetCDF format.

Parameters:

n_frames : int, optional

If n_frames is not None, the next n_frames of data from the file will be read. Otherwise, all of the frames in the file will be read.

stride : int, optional

If stride is not None, read only every stride-th frame from disk.

atom_indices : np.ndarray, dtype=int, optional

The specific indices of the atoms you’d like to retreive. If not supplied, all of the atoms will be retreived.
Returns:

coordinates : np.ndarray, shape=(n_frames, n_atoms, 3)

The cartesian coordinates of the atoms, in units of angstroms.

time : np.ndarray, None

The time corresponding to each frame, in units of picoseconds, or None if no time information is present in the trajectory.

cell_lengths : np.ndarray, None

The lengths (a,b,c) of the unit cell for each frame, or None if the information is not present in the file.

cell_angles : np.ndarray, None

The angles (lpha, eta, gamma) defining the unit cell for each frame, or None if the information is not present in the file.
write(coordinates, time=None, cell_lengths=None, cell_angles=None)

Write one or more frames of a molecular dynamics trajectory to disk in the AMBER NetCDF format.

Parameters:

coordinates : np.ndarray, dtype=np.float32, shape=(n_frames, n_atoms, 3)

The cartesian coordinates of each atom, in units of angstroms.

time : np.ndarray, dtype=np.float32, shape=(n_frames), optional

The time index corresponding to each frame, in units of picoseconds.

cell_lengths : np.ndarray, dtype=np.double, shape=(n_frames, 3)

The lengths (a,b,c) of the unit cell for each frame.

cell_angles : np.ndarray, dtype=np.double, shape=(n_frames, 3)

The angles (lpha, eta, gamma) defining the unit cell for each frame.

Notes

If the input arrays are of dimension deficient by one, for example if the coordinates array is two dimensional, the time is a single scalar or cell_lengths and cell_angles are a 1d array of length three, that is okay. You’ll simply be saving a single frame.

flush()

Write all buffered data in the to the disk file.

seek(offset, whence=0)

Move to a new file position

Parameters:

offset : int

A number of frames.

whence : {0, 1, 2}

0: offset from start of file, offset should be >=0. 1: move relative to the current position, positive or negative 2: move relative to the end of file, offset should be <= 0. Seeking beyond the end of a file is not supported
tell()

Current file position

Returns:

offset : int

The current frame in the file.
close()

Close the NetCDF file handle

Versions