gridSileSiesta

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

Binary real-space grid file

Attributes

base_file	File of the current Sile
file	File of the current Sile

Methods

__init__(filename[, mode])	Initialize self.
dir_file([filename])	File of the current Sile
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

base_file

File of the current Sile

dir_file(filename=None)

File of the current Sile

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 or array_like, optional

the spin-index for retrieving one of the components. If a vector is passed it refers to the fraction per indexed component. I.e. [0.5, 0.5] will return sum of half the first two components. Default to the first component.

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.