sisl.io.siesta.bandsSileSiesta

class sisl.io.siesta.bandsSileSiesta(filename, *args, **kwargs)

Bandstructure information

Methods

`base_directory`([relative_to])	Retrieve the base directory of the file, relative to the path relative_to
`close`()
`dir_file`([filename, filename_base])	File of the current Sile
`read`(args, *kwargs)	Generic read method which should be overloaded in child-classes
`read_data`([as_dataarray])	Returns data associated with the bands file
`read_fermi_level`()	Returns the Fermi level in the bands file
`write`(args, *kwargs)	Generic write method which should be overloaded in child-classes
`base_file`	File of the current Sile
`file`	File of the current Sile
`plot`	Handles all plotting possibilities for a class

__init__(filename, mode='r', *args, **kwargs): Just to pass away the args and kwargs

base_directory(relative_to='.'): Retrieve the base directory of the file, relative to the path relative_to

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_data(as_dataarray: bool = False)[source]

Returns data associated with the bands file

The energy levels are shifted with respect to the Fermi-level.

Parameters:: as_dataarray (boolean, optional) – if True, the information is returned as an xarray.DataArray Ticks (if read) are stored as an attribute of the DataArray (under array.ticks and array.ticklabels)

read_fermi_level() → float[source]

Returns the Fermi level in the bands 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.