sisl.io.openmx.omxSileOpenMX

class sisl.io.openmx.omxSileOpenMX(filename, *args, **kwargs)

Bases: SileOpenMX

OpenMX-input file

By supplying base you can reference files in other directories. By default the base is the directory given in the file name.

Parameters:

• filename (str) – input file

• mode (str, optional) – opening mode, default to read-only

• base (str, optional) – base-directory to read output files from.

Examples

>>> omx = omxSileOpenMX("tmp/input.dat") # reads output files in 'tmp/' folder
>>> omx = omxSileOpenMX("tmp/input.dat", base=".") # reads output files in './' folder

When using this file in conjunction with the sgeom script while your input data-files are named input.dat, please do this:

sgeom input.dat{omx} output.xyz

which forces the use of the omx 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
get(key[, default])	Retrieve keyword from the file
read(*args, **kwargs)	Generic read method which should be overloaded in child-classes
read_basis(*args, **kwargs)	Reads basis
read_geometry([output])	Returns Geometry object
read_lattice([output])	Reads lattice
type(label)	Return the type of the fdf-keyword
write(*args, **kwargs)	Generic write method which should be overloaded in child-classes
base_file	File of the current Sile
file	Return the current file name (without the directory prefix)
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

Return the current file name (without the directory prefix)

get(key, default=None)

Retrieve keyword from the file

Parameters:

• key (str) – the key to search for

• default (optional) – if the key is not found, this will be the returned value (default to None)

Returns:

value – a real value a float (or if the default is of float), for an integer, an int is returned.

Return type:

the value of the key. If the key is a block, a list is returned, for

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_basis(*args, **kwargs)

Reads basis

Parameters:

• output (bool, optional) – whether to read lattice from output files (default to read from the input file).

• order ({'dat', 'omx'}) – the order of which to try and read the lattice If order is present output is disregarded.

read_geometry(output: bool = False, *args, **kwargs) → Geometry

Returns Geometry object

One can limit the tried files to only one file by passing only a single file ending.

Parameters:

• output (bool) – whether to read geometry from output files (default to read from the input file).

• order ({'dat', 'omx'}) – the order of which to try and read the geometry. If order is present output is disregarded.

Return type:

Geometry

read_lattice(output: bool = False, *args, **kwargs) → Lattice

Reads lattice

One can limit the tried files to only one file by passing only a single file ending.

Parameters:

• output (bool) – whether to read lattice from output files (default to read from the input file).

• order ({'dat', 'omx'}) – the order of which to try and read the lattice. If order is present output is disregarded.

Return type:

Lattice

type(label)

Return the type of the fdf-keyword

Parameters:

label (str) – the label to look-up

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.