SileCDF

class sisl.io.SileCDF(filename, mode='r', lvl=0, access=1, *args, **kwargs)

Bases: sisl.io.BaseSile

Creates/Opens a SileCDF

Opens a SileCDF with mode and compression level lvl. If mode is in read-mode (r) the compression level is ignored.

The final access parameter sets how the file should be open and subsequently accessed.

0. means direct file access for every variable read

1. means stores certain variables in the object.

Attributes

__dict__
__doc__
__module__
__weakref__	list of weak references to the object (if defined)
_cmp_args	Returns the compression arguments for the NetCDF file
_write_default
_write_default_only
base_file	File of the current Sile
file	File of the current Sile

Methods

_ArgumentParser_args_single()	Default arguments for the Sile
__delattr__	Implement delattr(self, name).
__dir__	Default dir() implementation.
__enter__()	Opens the output file and returns it self
__eq__	Return self==value.
__exit__(type, value, traceback)
__format__	Default object formatter.
__ge__	Return self>=value.
__getattr__(name)	Override to check the handle
__getattribute__	Return getattr(self, name).
__gt__	Return self>value.
__hash__	Return hash(self).
__init__(filename[, mode, lvl, access])	Initialize self.
__init_subclass__	This method is called when a class is subclassed.
__iter__([group, dimension, variable, …])	Iterator on all groups, variables and dimensions.
__le__	Return self<=value.
__lt__	Return self<value.
__ne__	Return self!=value.
__new__	Create and return a new object.
__reduce__	Helper for pickle.
__reduce_ex__	Helper for pickle.
__repr__	Return repr(self).
__setattr__	Implement setattr(self, name, value).
__sizeof__	Size of object in memory, in bytes.
__str__()	Return a representation of the Sile
__subclasshook__	Abstract classes can override this to customize issubclass().
_base_file(f)	Make f refer to the file with the appropriate base directory
_base_setup(*args, **kwargs)	Setup the Sile after initialization
_crt_dim(n, name, l)
_crt_grp(n, name)
_crt_var(n, name, *args, **kwargs)
_dimension(name[, tree])	Local method for obtaing the dimension in a certain tree
_dimensions(n, name[, tree])	Retrieve method to get the NetCDF variable
_setup(*args, **kwargs)	Setup the Sile after initialization
_value(name[, tree])	Local method for obtaining the data from the SileCDF.
_variable(name[, tree])	Local method for obtaining the data from the SileCDF.
_variables(n, name[, tree])	Retrieve method to get the NetCDF variable
close()
dir_file([filename])	File of the current Sile
exist()	Query whether the file exists
iter([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

property base_file

File of the current Sile

close()

dir_file(filename=None)

File of the current Sile

exist()

Query whether the file exists

property file

File of the current Sile

iter(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:

1. Group

2. Dimensions in group

3. 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.

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(*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(*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.