sisl.io.siesta.binaries module

Sile object for reading/writing SIESTA binary files

class sisl.io.siesta.binaries.TSHSSileSiesta(filename, mode='r')

Bases: sisl.io.siesta.sile.SileBinSIESTA

TranSIESTA file object

Attributes

file	File of the current Sile

Methods

ArgumentParser([parser])	Returns the arguments that may be available for this Sile
ArgumentParser_out([parser])	Appends additional arguments based on the output of the file
read(*args, **kwargs)	Generic read method which should be overloaded in child-classes
read_es(**kwargs)	Returns the electronic structure from the siesta.TSHS file
read_geom()	Returns Geometry object from a siesta.TSHS file
read_sc()	Returns a SuperCell object from a siesta.TSHS file
write(*args, **kwargs)	Generic write method which should be overloaded in child-classes

Creates/Opens a SileBin

Opens a SileBin with mode (b). If mode is in read-mode (r).

Attributes

file	File of the current Sile

Methods

ArgumentParser([parser])	Returns the arguments that may be available for this Sile
ArgumentParser_out([parser])	Appends additional arguments based on the output of the file
read(*args, **kwargs)	Generic read method which should be overloaded in child-classes
read_es(**kwargs)	Returns the electronic structure from the siesta.TSHS file
read_geom()	Returns Geometry object from a siesta.TSHS file
read_sc()	Returns a SuperCell object from a siesta.TSHS file
write(*args, **kwargs)	Generic write method which should be overloaded in child-classes

read_es(**kwargs)

Returns the electronic structure from the siesta.TSHS file

read_geom()

Returns Geometry object from a siesta.TSHS file

read_sc()

Returns a SuperCell object from a siesta.TSHS file