oemof.tabular.tools package¶

oemof.tabular’s kitchen sink module.

Contains all the general tools needed by other tools dealing with specific tabular data sources.

class oemof.tabular.tools.HSN[source]¶

Bases: types.SimpleNamespace

A hashable variant of types.Simplenamespace.

By making it hashable, we can use the instances as dictionary keys, which is necessary, as this is the default type for flows.

oemof.tabular.tools.raisestatement(exception, message='')[source]¶: A version of raise that can be used as a statement.

oemof.tabular.tools.remap(mapping, renamings, selection)[source]¶

Change mapping’s keys according to the selection in renamings.

The renaming found under selection in renamings is used to rename the keys found in mapping. I.e., return a copy of mapping with every key of mapping that is also found in renaming replaced with renaming[key].

If key doesn’t have a renaming, it’s returned as is. If selection doesn’t appear as a key in renamings, mapping is returned unchanged.

Example

>>> renamings = {'R1': {'zero': 'nada'}, 'R2': {'foo': 'bar'}}
>>> mapping = {'zero': 0, 'foo': 'foobar'}
>>> remap(mapping, renamings, 'R1') == {'nada': 0, 'foo': 'foobar'}
True
>>> remap(mapping, renamings, 'R2') == {'zero': 0, 'bar': 'foobar'}
True

As a special case, if selection is a class, not only selection is considered to select a renaming, but the classes in selection’s mro are considered too. The first class in selection’s mro which is also found to be a key in renamings is used to determine which renaming to use. The search starts at selection.

Parameters:	mapping (Mapping) – The Mapping whose keys should be renamed. renamings (Mapping of Mappings <collections.abc.Mapping>) selection (Hashable) – Key specifying which entry in renamings is used to determine the new keys in the copy of mapping. If selection is a class, the first entry of selection’s mro which is found in renamings is used to determine the new keys.

Submodules¶

oemof.tabular.tools.geometry module¶

The code in this module is partly based on third party code which has been licensed under GNU-GPL3. The following functions are copied and adapted from:

_shape2poly()
simplify_poly()
nuts()

oemof.tabular.tools.geometry.Shapes2Shapes(orig, dest, normed=True, equalarea=False, prep_first=True, **kwargs)[source]¶

Notes

oemof.tabular.tools.geometry.intersects(geom, labels, geometries)[source]¶

oemof.tabular.tools.geometry.nuts(filepath=None, nuts=0, subset=None, tolerance=0.03, minarea=1.0)[source]¶

Reads shapefile with nuts regions and converts to polygons

Returns:	OrderedDict – Country keys as keys of dict and shapely polygons as corresponding values

Notes

oemof.tabular.tools.geometry.read_geometries(filename, directory='data/geometries')[source]¶

Reads geometry resources from the datapackage. Data may either be stored in geojson format or as WKT representation in CSV-files.

Parameters:	filename (string) – Name of the elements to be read, for example buses.geojson directory (string) – Directory where the file is located. Default: data/geometries
Returns:	pd.Series

oemof.tabular.tools.geometry.reproject(geom, fr=<sphinx.ext.autodoc.importer._MockObject object>, to=<sphinx.ext.autodoc.importer._MockObject object>)[source]¶

Notes

oemof.tabular.tools.geometry.simplify_poly(poly, tolerance)[source]¶

Notes

oemof.tabular.tools.geometry.write_geometries(filename, geometries, directory='data/geometries')[source]¶

Writes geometries to filesystem.

Parameters:	filename (string) – Name of the geometries stored, for example buses.geojson geometries (pd.Series) – Index entries become name fields in GeoJSON properties. directory (string) – Directory where the file is stored. Default: data/geometries
Returns:	path (string) – Returns the path where the file has been stored.