sisl.io.siesta.kpSileSiesta

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

Bases: SileSiesta

k-points file in 1/Bohr units

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

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

read_data([lattice])

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

Attributes

base_file

File of the current Sile

file

File of the current Sile
base_directory(relative_to='.')

Retrieve the base directory of the file, relative to the path relative_to

close()
dir_file(filename=None, filename_base='')

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(lattice: Lattice | LatticeChild | None) → BrillouinZone[source]

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

Parameters:

lattice (LatticeChild) – required supercell for the BrillouinZone object

Returns:

bz (BrillouinZone)

read_data(lattice: Lattice | LatticeChild | None = None)[source]

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

Parameters:

lattice – 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: BrillouinZone, fmt: str = '.9e')[source]

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: str = '.9e')[source]

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

property base_file

File of the current Sile

property file

File of the current Sile