sisl.io.scaleup.rhamSileScaleUp

class sisl.io.scaleup.rhamSileScaleUp(filename, *args, **kwargs)[source]

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

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

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[source]: Reads a Hamiltonian from the Sile

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.