MSPypeline

import with:

from mspypeline import MSPParser, UIHandler, MSPGUI
class mspypeline.MSPParser
Uses the argparse module to provide a parser for command line options, arguments and sub-commands through which the analysis can be started or the GUI can be called (see Getting started).
class mspypeline.UIHandler(file_dir, yml_file=None, gui=False, host_flask=False, selected_reader=<class 'mspypeline.file_reader.MQReader.MQReader'>, loglevel=10, configs=None)
Used to take the mapping of arguments provided by the MSPParser through the command line to organize through which point of entry the data analysis should be performed.
The UIHandler can initialize the creation of the GUI, perform the whole analysis instantly by running the pipeline and creating all plots according to the configs or (not yet available) host the mspypeline on a flask server.
__init__(file_dir, yml_file=None, gui=False, host_flask=False, selected_reader=<class 'mspypeline.file_reader.MQReader.MQReader'>, loglevel=10, configs=None)
Parameters

  • file_dir – location where the directory/txt folder to the data can be found.

  • yml_file – path to the yaml config file

  • gui – should a GUI be compiled

  • host_flask – currently not implemented (should a flsk server be hosted)

  • selected_reader – instance of an BaseReader used to process data to an internal format for the plotter.

  • loglevel – level of the logger

  • configs (dict) – mapping of configuration

class mspypeline.MSPGUI(file_dir, yml_file=None, loglevel=10, configs=None)
This class is called from the UIHandler to create the GUI.
__init__(file_dir, yml_file=None, loglevel=10, configs=None)
Parameters

  • file_dir – location where the directory/txt folder to the data can be found.

  • yml_file – path to the yaml config file

  • loglevel – level of the logger

  • configs (dict) – mapping containing the configurations