You're reading an old version of this documentation. For up-to-date information, please have a look at v0.3.

aspecd.system module

Obtaining information on the system used for data processing and analysis.

One key aspect of reproducibility is to record sufficient details of the system used to perform processing and analysis. Therefore, each aspecd.dataset.HistoryRecord contains a field with system information that is an aspecd.system.SystemInfo object.

General information stored within the aspecd.system.SystemInfo class are the Python version, the platform, as well as the login name of the user currently logged in. Therefore, this is a relevant aspect for personal data protection, and each and every user of the system should be made available of this fact.

class aspecd.system.SystemInfo(package='')

Bases: aspecd.utils.ToDictMixin

General information on the system used.

python

Version of Python (and potentially further information)

Type

dict

packages

Relevant modules and their version numbers

Type

dict

platform

Identifier of the platform

Type

string

user

Currently only the login name of the currently logged-in user

Type

dict

Parameters

package (str) –

Name of package whose version shall be added to the modules dictionary

Useful (and necessary) for packages derived from the ASpecD framework to store their version number in the SystemInfo class and hence in the history records. Prerequisite for reproducibility.

from_dict(dict_=None)

Set properties from dictionary.

Only parameters in the dictionary that are valid properties of the class are set accordingly.

Parameters

dict (dict) – Dictionary containing properties to set

to_dict()

Create dictionary containing public attributes of an object.

Returns

public_attributes – Ordered dictionary containing the public attributes of the object

The order of attribute definition is preserved

Return type

collections.OrderedDict