ionncSileSiesta¶
-
class
sisl.io.siesta.
ionncSileSiesta
(filename, mode='r', lvl=0, access=1, *args, **kwargs)[source]¶ Basis set information in NetCDF files
Note that the
ion.nc
files are equivalent to theion.xml
files.Attributes
File of the current Sile
File of the current Sile
Methods
__init__
(self, filename[, mode, lvl, access])Initialize self.
close
(self)dir_file
(self[, filename])File of the current Sile
exist
(self)Query whether the file exists
iter
(self[, group, dimension, variable, …])Iterator on all groups, variables and dimensions.
read
(self, \*args, \*\*kwargs)Generic read method which should be overloaded in child-classes
read_basis
(self)Returns data associated with the ion.xml file
write
(self, \*args, \*\*kwargs)Generic write method which should be overloaded in child-classes
-
property
base_file
¶ File of the current Sile
-
close
(self)¶
-
dir_file
(self, filename=None)¶ File of the current Sile
-
exist
(self)¶ Query whether the file exists
-
property
file
¶ File of the current Sile
-
iter
(self, group=True, dimension=True, variable=True, levels=-1, root=None)¶ Iterator on all groups, variables and dimensions.
This iterator iterates through all groups, variables and dimensions in the
Dataset
The generator sequence will _always_ be:
Group
Dimensions in group
Variables in group
As the dimensions are generated before the variables it is possible to copy groups, dimensions, and then variables such that one always ensures correct dependencies in the generation of a new
SileCDF
.- Parameters
- group
bool
(True) whether the iterator yields Group instances
- dimension
bool
(True) whether the iterator yields Dimension instances
- variable
bool
(True) whether the iterator yields Variable instances
- levels
int
(-1) number of levels to traverse, with respect to
root
variable, i.e. number of sub-groups this iterator will return.- root
str
(None) the base root to start iterating from.
- group
Examples
Script for looping and checking each instance.
>>> for gv in self.iter(): ... if self.isGroup(gv): ... # is group ... elif self.isDimension(gv): ... # is dimension ... elif self.isVariable(gv): ... # is variable
-
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.
-
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.
-
property