sisl.io.xsf module¶
Sile object for reading/writing XSF (XCrySDen) files
-
class
sisl.io.xsf.
XSFSile
(filename, mode='r', comment='#')[source]¶ Bases:
sisl.io.sile.Sile
XSF file object
Attributes
file
File of the current Sile
Methods
ArgumentParser
(*args, **kwargs)Returns the arguments that is available for this Sile ArgumentParser_out
(p, *args, **kwargs)Adds arguments only if this file is an output file is_keys
(keys)Returns true if isinstance(keys,(list,np.ndarray))
key2case
(key, case)Converts str/list of keywords to proper case keys2case
(keys, case)Converts str/list of keywords to proper case line_has_key
(line, key[, case])line_has_keys
(line, keys[, case])read
(*args, **kwargs)Generic read method which should be overloaded in child-classes read_geom
(*args, **kwargs)readline
([comment])Reads the next line of the file step_either
(keywords[, case])Steps the file-handle until the keyword is found in the input step_to
(keywords[, case])Steps the file-handle until the keyword is found in the input write
(*args, **kwargs)Generic write method which should be overloaded in child-classes write_geom
(*args, **kwargs)-
ArgumentParser_out
(p, *args, **kwargs)[source]¶ Adds arguments only if this file is an output file
Parameters: p :
argparse.ArgumentParser
the parser which gets amended the additional output options.
-
read_geom
(*args, **kwargs)¶
-
write_geom
(*args, **kwargs)¶
-