Source code for sisl.io.xyz

"""
Sile object for reading/writing XYZ files
"""

from __future__ import print_function

import numpy as np

# Import sile objects
from .sile import *

# Import the geometry object
from sisl import Geometry, Atom, SuperCell


__all__ = ['XYZSile']


[docs]class XYZSile(Sile): """ XYZ file object """ def _setup(self): """ Setup the `XYZSile` after initialization """ self._comment = [] @Sile_fh_open def write_geometry(self, geom, fmt='.8f'): """ Writes the geometry to the contained file """ # Check that we can write to the file sile_raise_write(self) # Write the number of atoms in the geometry self._write(' {}\n'.format(len(geom))) # Write out the cell information in the comment field # This contains the cell vectors in a single vector (3 + 3 + 3) # quantities, plus the number of supercells (3 ints) fmt_str = 'cell= ' + '{{:{0}}} '.format(fmt) * 9 + ' nsc= {} {} {}\n'.format(*geom.nsc[:]) self._write(fmt_str.format(*geom.cell.flatten())) fmt_str = '{{0:2s}} {{1:{0}}} {{2:{0}}} {{3:{0}}}\n'.format(fmt) for ia, a, isp in geom.iter_species(): self._write(fmt_str.format(a.symbol, *geom.xyz[ia, :])) # Add a single new line self._write('\n') @Sile_fh_open def read_geometry(self): """ Returns Geometry object from the XYZ file NOTE: Unit-cell is the Eucledian 3D space. """ cell = np.asarray(np.diagflat([1] * 3), np.float64) nsc = [1, 1, 1] l = self.readline() na = int(l) l = self.readline() l = l.split() if len(l) == 9: # we possibly have the cell as a comment cell.shape = (9,) for i, il in enumerate(l): cell[i] = float(il) cell.shape = (3, 3) elif len(l) > 9: # We may have the latest version of sisl xyz coordinates try: cell.shape = (9,) for i, il in enumerate(l[1:10]): cell[i] = float(il) # Try and read the nsc for i, il in enumerate(l[11:14]): nsc[i] = int(il) finally: cell.shape = (3, 3) sp = [None] * na xyz = np.empty([na, 3], np.float64) for ia in range(na): l = self.readline().split() sp[ia] = l.pop(0) xyz[ia, :] = [float(k) for k in l[:3]] return Geometry(xyz, atom=sp, sc=SuperCell(cell, nsc=nsc))
[docs] def ArgumentParser(self, *args, **kwargs): """ Returns the arguments that is available for this Sile """ newkw = Geometry._ArgumentParser_args_single() newkw.update(kwargs) return self.read_geometry().ArgumentParser(*args, **newkw)
add_sile('xyz', XYZSile, case=False, gzip=True)