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
filewrite
(*args, **kwargs)Generic write method which should be overloaded in child-classes
Attributes
File of the current Sile
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_hamiltonian(geometry: Geometry | None = None, dtype=np.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 – the geometry associated with the Hamiltonian
lattice (
sisl.Lattice
, optional) – the lattice associated with the 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.
- property base_file
File of the current Sile
- property file
File of the current Sile