sisl.io.siesta.structSileSiesta

class sisl.io.siesta.structSileSiesta(filename, mode='r', comment=None, *args, **kwargs)

Bases: sisl.io.siesta.SileSiesta

Geometry file

Methods

dir_file([filename, filename_base])	File of the current Sile
read(*args, **kwargs)	Generic read method which should be overloaded in child-classes
read_geometry([species_Z])	Returns a Geometry object from the STRUCT file
read_supercell()	Returns SuperCell object from the STRUCT file
write(*args, **kwargs)	Generic write method which should be overloaded in child-classes
write_geometry(geometry[, fmt])	Writes the geometry to the contained file
base_file	File of the current Sile
file	File of the current Sile

__init__(filename, mode='r', comment=None, *args, **kwargs)

property base_file

File of the current Sile

dir_file(filename=None, filename_base='')

File of the current Sile

property file

File of the current Sile

read(*args, **kwargs)

Generic read method which should be overloaded in child-classes

Parameters

kwargs – keyword arguments will try and search for the attribute read_<> and call it with the remaining **kwargs as arguments.

read_geometry(species_Z=False)

Returns a Geometry object from the STRUCT file

Parameters

species_Z (bool, optional) – if True the atomic numbers are the species indices (useful when reading the ChemicalSpeciesLabel block simultaneously).

Return type

Geometry

read_supercell()

Returns SuperCell object from the STRUCT file

write(*args, **kwargs)

Generic write method which should be overloaded in child-classes

Parameters

**kwargs – keyword arguments will try and search for the attribute write_ and call it with the remaining **kwargs as arguments.

write_geometry(geometry, fmt='.9f')

Writes the geometry to the contained file

Parameters

• geometry (Geometry) – geometry to write in the XV file

• fmt (str, optional) – the precision used for writing the XV file