refSileScaleUp

class sisl.io.scaleup.refSileScaleUp(filename, mode='r', comment=None, *args, **kwargs)

REF file object for ScaleUp

Attributes

base_file	File of the current Sile
file	File of the current Sile

Methods

__init__(self, filename[, mode, comment])	Initialize self.
dir_file(self[, filename])	File of the current Sile
exist(self)	Query whether the file exists
read(self, \*args, \*\*kwargs)	Generic read method which should be overloaded in child-classes
read_geometry(self[, primary])	Reads a geometry from the Sile
read_supercell(self)	Reads a supercell from the Sile
write(self, \*args, \*\*kwargs)	Generic write method which should be overloaded in child-classes
write_geometry(self, geom[, fmt])	Writes the geometry to the contained file

property base_file

File of the current Sile

dir_file(self, filename=None)

File of the current Sile

exist(self)

Query whether the file exists

property file

File of the current Sile

read(self, *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_geometry(self, primary=False, **kwargs)

Reads a geometry from the Sile

read_supercell(self)

Reads a supercell from the Sile

write(self, *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_geometry(self, geom, fmt='18.8e')

Writes the geometry to the contained file