sisl.io.gulp package¶
Submodules¶
Module contents¶
GULP I/O Siles
-
class
sisl.io.gulp.
SileGULP
(filename, mode='r', comment='#')[source]¶ Bases:
sisl.io.sile.Sile
Attributes
file
File of the current Sile
Methods
ArgumentParser
([parser])Returns the arguments that may be available for this Sile ArgumentParser_out
([parser])Appends additional arguments based on the output of the 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 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
-
class
sisl.io.gulp.
SileCDFGULP
(filename, mode='r', lvl=0, access=1, _open=True)[source]¶ Bases:
sisl.io.sile.SileCDF
Creates/Opens a SileCDF
Opens a SileCDF with
mode
and compression levellvl
. Ifmode
is in read-mode (r) the compression level is ignored.The final
access
parameter sets how the file should be open and subsequently accessed.- means direct file access for every variable read
- means stores certain variables in the object.
Attributes
file
Filename of the current Sile
Methods
ArgumentParser
([parser])Returns the arguments that may be available for this Sile ArgumentParser_out
([parser])Appends additional arguments based on the output of the file isDataset
(obj)Return true if obj
is an instance of the NetCDF4Dataset
typeisDimension
(obj)Return true if obj
is an instance of the NetCDF4Dimension
typeisGroup
(obj)Return true if obj
is an instance of the NetCDF4Group
typeisRoot
(obj)Return true if obj
is an instance of the NetCDF4Dataset
typeisVariable
(obj)Return true if obj
is an instance of the NetCDF4Variable
typeiter
([group, dimension, variable, levels, root])Iterator on all groups, variables and dimensions. read
(*args, **kwargs)Generic read method which should be overloaded in child-classes write
(*args, **kwargs)Generic write method which should be overloaded in child-classes
-
class
sisl.io.gulp.
gotSileGULP
(filename, mode='r', comment='#')[source]¶ Bases:
sisl.io.gulp.sile.SileGULP
GULP output file object
Attributes
file
File of the current Sile
Methods
ArgumentParser
([parser])Returns the arguments that may be available for this Sile ArgumentParser_out
([parser])Appends additional arguments based on the output of the 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_dynmat
(*args, **kwargs)read_es
(*args, **kwargs)read_geom
(*args, **kwargs)read_sc
(*args, **kwargs)read_super
(*args, **kwargs)readline
([comment])Reads the next line of the file set_dyn_key
(key)Overwrites internal key lookup value for the dynamical matrix vectors set_es_key
(key)Overwrites internal key lookup value for the dynamical matrix vectors set_geom_key
(key)Overwrites internal key lookup value for the geometry vectors set_key
(segment, key)Sets the segment lookup key set_sc_key
(key)Overwrites internal key lookup value for the cell vectors 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 -
read_dynmat
(*args, **kwargs)¶
-
read_es
(*args, **kwargs)¶
-
read_geom
(*args, **kwargs)¶
-
read_sc
(*args, **kwargs)¶
-
read_super
(*args, **kwargs)¶
-
set_es_key
(key)¶ Overwrites internal key lookup value for the dynamical matrix vectors
-
-
class
sisl.io.gulp.
HessianSileGULP
(filename, mode='r', comment='#')[source]¶ Bases:
sisl.io.gulp.sile.SileGULP
GULP output file object
Attributes
file
File of the current Sile
Methods
ArgumentParser
([parser])Returns the arguments that may be available for this Sile ArgumentParser_out
([parser])Appends additional arguments based on the output of the 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_dynmat
(*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 -
read_dynmat
(*args, **kwargs)¶
-