sisl.io.siesta.bandsSileSiesta¶
- class sisl.io.siesta.bandsSileSiesta(filename, mode='r', comment=None, *args, **kwargs)¶
Bases:
sisl.io.siesta.SileSiesta
Bandstructure information
Methods
dir_file
([filename, filename_base])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_data
([as_dataarray])Returns data associated with the bands file
write
(*args, **kwargs)Generic write method which should be overloaded in child-classes
File of the current Sile
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
- exist()¶
Query whether the file exists
- 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_data(as_dataarray=False)[source]¶
Returns data associated with the bands file
- 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)
- 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.