GridSileSiesta

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

Grid file object from a binary Siesta output file

Attributes

file	File of the current Sile

Methods

__init__(filename[, mode])	Creates/Opens a SileBin
exist()	Query whether the file exists
read(*args, **kwargs)	Generic read method which should be overloaded in child-classes
read_grid([spin])	Read grid contained in the Grid file
read_supercell(*args, **kwargs)
write(*args, **kwargs)	Generic write method which should be overloaded in child-classes

exist()

Query whether the file exists

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_grid(spin=0, *args, **kwargs)

Read grid contained in the Grid file

Parameters:

spin : int, optional

the returned spin

read_supercell(*args, **kwargs)

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.