pybec.parsers.get_dipole

pybec.parsers.get_dipole(output_file)

Retrieves the electric and ionic polarizations from output file.

Parameters

output_file (str) – File path to the output file for the step from which to pull polarizations.

Returns

header, pols. Header is a list of the header names associated with pols. pols is an N X 5 np.ndarray. For each of N steps, it contains The associated step number, timestep, electronic, ionic, and total cell dipole.

Return type

tuple