kpSileSiesta

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

k-points file in 1/Bohr units

Attributes

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

Methods

__init__(filename[, mode, comment])	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_brillouinzone(sc)	Returns K-points from the file (note that these are in reciprocal units)
read_data([sc])	Returns K-points from the file (note that these are in reciprocal units)
write(*args, **kwargs)	Generic write method which should be overloaded in child-classes
write_brillouinzone(bz[, fmt])	Writes BrillouinZone-points to file
write_data(k, weight[, fmt])	Writes K-points to file

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_brillouinzone(sc)

Returns K-points from the file (note that these are in reciprocal units)

Parameters:

sc : SuperCellChild

required supercell for the BrillouinZone object

Returns:

bz : BrillouinZone

read_data(sc=None)

Returns K-points from the file (note that these are in reciprocal units)

Parameters:

sc : SuperCellChild, optional

if supplied the returned k-points will be in reduced coordinates

Returns:

k : k-points, in units 1/Bohr

w : weights for k-points

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.

write_brillouinzone(bz, fmt='.9e')

Writes BrillouinZone-points to file

Parameters:

bz : BrillouinZone

object contain all weights and k-points

fmt : str, optional

format for the k-values

write_data(k, weight, fmt='.9e')

Writes K-points to file

Parameters:

k : array_like

k-points in units 1/Bohr

weight : array_like

same length as k, weights of k-points

fmt : str, optional

format for the k-values