sisl.io.scaleup.rhamSileScaleUp

class sisl.io.scaleup.rhamSileScaleUp(filename, *args, **kwargs)

Bases: SileScaleUp

rham file object for ScaleUp

This file contains the real-space Hamiltonian for a ScaleUp simulation

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)	Reads a Hamiltonian from the Sile
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

property base_file

File of the current Sile

close()

dir_file(filename=None, filename_base='')

File of the current Sile

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_hamiltonian(geometry: Geometry) → Hamiltonian

Reads a Hamiltonian from the Sile

Parameters:

geometry (Geometry)

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.