cmf.describe Namespace Reference

Detailed Description

Author: Florian U. Jehn & Philipp Kraft
Original version from ACME (https://github.com/zutn/ACME)

The version here is different - the describe function tries to describe everything

Functions
	_describe_timeseries (ts)
	describe (cmfobject, out=None)

Function Documentation

_describe_timeseries()

_describe_timeseries ( ts )

protected

Describes a cmf timeseries with its start, end, step, min, mean and max.

:param: ts: a cmf.timeseries
:return: None

describe()

describe	(		cmfobject,
			out = None )

Describes a cmf object in a file like object or returns the description.

If no special description method for the class of cmfobject is available,
the function writes the string representation

:param cmfobject: any cmf object eg. project, Cell, timeseries
:param out: filelike object, if None function returns the description as string
:return: If out is None it returns the description as string, else no return