Configurations subpackage

Many things need configuration, and changing values in a configuration file can at the same time be much easier than having to hard-wire something in code. Eventually, each part of the eprcontrol package should be fully configurable, allowing the end user to only change parameters in configuration files to change not only experimental parameters, but the composition of setups as well. The base class for configurations is eprcontrol.configurations.Configuration. Every configuration should inherit from this class.

Classes

class eprcontrol.configurations.Configuration

Bases: handle

Base class for configurations

configuration

actual configuration values in an associative array

Type

struct

from_file(filename)

Obtain configuration from file

Parameters

filename (string) – Name of the configuration file

Returns

file_contents – Configuration imported from file

Return type

struct

Currently, three different file formats are supported:

  • MATLAB® mat files

  • JSON files

  • YAML files

YAML files are supported using the eprcontrol.utils.YAML class.