sisl.io.wannier90.hrSileWannier90

class sisl.io.wannier90.hrSileWannier90(filename, *args, **kwargs)[source]

Bases: hamSileWannier90

Wannier90 Hamiltonian file

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_hamiltonian`([geometry, dtype])	Reads a Hamiltonian model from the `<>_hr.dat` 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

__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_hamiltonian(geometry: Optional[Geometry] = None, dtype=<class 'numpy.float64'>, **kwargs) → Hamiltonian[source]

Reads a Hamiltonian model from the <>_hr.dat file

Parameters:

cutoff – the cutoff value for the zero Hamiltonian elements, default to 0.00001 eV.
dtype (np.float64, optional) – the default data-type used for the matrix. Is mainly useful to check whether the TB model has imaginary components (it should not since it is a Wannier model).
geometry (Optional[Geometry]) – the geometry associated with the Hamiltonian
lattice (Lattice, optional) – the lattice associated with the Hamiltonian

Return type:

Hamiltonian

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.