sisl.io.scaleup.refSileScaleUp

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

Bases: SileScaleUp

REF file object for ScaleUp

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_geometry([primary])	Reads a geometry from the Sile
read_lattice()	Reads a supercell from the Sile
write(*args, **kwargs)	Generic write method which should be overloaded in child-classes
write_geometry(geometry[, fmt])	Writes the geometry to the contained file
base_file	File of the current Sile
file	File of the current Sile
plot	Handles all plotting possibilities for a class

__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

plot

Handles all plotting possibilities for a class

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_geometry(primary: bool = False, **kwargs) → Geometry

Reads a geometry from the Sile

Parameters:

primary (bool)

Return type:

Geometry

read_lattice() → Lattice

Reads a supercell from the Sile

Return type:

Lattice

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.

write_geometry(geometry: Geometry, fmt: str = '18.8e')

Writes the geometry to the contained file

Parameters:

• geometry (Geometry)

• fmt (str)