mad-gui 0.2.0a3

GUI for annotating and processing IMU data.

MaD GUI

Machine Learning and Data Analytics Graphical User Interface

Contents of this readme

• What is it?
• How do I use it (videos)
• How do I get the GUI to work on my machine?
• How can I test the GUI using your example data on my computer?
• Can I use it with data of my specific system or a specific algorithm?
• Can I change something at the core of the GUI?

What is it?

The MaD GUI is a framework for processing time series data. Its use-cases include visualization, annotation (manual or automated), and algorithmic processing of visualized data and annotations.

How do I use it?

Videos

By clicking on the images below, you will be redirected to YouTube. In case you want to follow along on your own machine, check out the section How do I get the GUI to work on my machine? first.

Shortcuts

Please watch the videos linked above, if you want to learn more about the different actions.

Shortcut	Mode	Action
a, e, r, s, Esc	all	Switch between modes Add label, Edit label, Remove label, Synchronize data
Space	Add label	Can be used instead of Left Mouse Click
1, 2, 3,... TAB	Add label	Navigate in the pop-up window
Shift + Left Mouse Click	Add label	Start a new label directly when setting the end of a label
Ctrl + Left Mouse Click	Add label	Add a single event

How do I get the GUI to work on my machine?

Below, we present two options how to obtain and run the GUI. However, this will only enable you to look at our example data. You want to load data of a specific format/system or want to use a specific algorithm? In this case please refer to Can I use it with data of my specific system or a specific algorithm?

How can I test the GUI using your example data on my computer?

First, you need to download the example data. Right click on this link, select Save link as... and save it - you have to change the file ending from *.txt to *.csv before saving. If you also want to check out synchronization with a video file, click on this link and save it on your machine. Next, use one of the following two options (for testing it on Windows, we recommend Option A).

Option A: Standalone executable

Operating system	What to do
Windows	Download our exemplary executable here. Note: If prompted with a dialog Windows protected your PC, click More info and then select Run anyway
other	Contact us

Start the program and then you can open the previously downloaded example data as shown in How do I use it (videos)?

Option B: Using the python package

pip install mad_gui

Make sure to include the underscore. If you do not include it, you will install a different package.

Then, from your command line either simply start the GUI (first line) or pass additional arguments (second line):

mad-gui
python -m mad_gui.start_gui --data_dir C:/my_data

Alternatively, within a python script use our start_gui function and hand it over the path where your data resides, <data_path> like C:/data or /home/data/:

from mad_gui import start_gui
start_gui(<data_path>)

Now you can open the previously downloaded example data as shown in How do I use it (videos)?

Can I use it with data of my specific system or a specific algorithm?

Yes, however it will need someone who is familiar with python to perform the steps described in Customization. You do not have experience with python but still want to load data from a specific system? Contact us!

Developers can get basic information about the project setup in our Developer Guidelines. If you want to extend the GUI with your custom plugins, e.g. for loading data of a specific system, or adding an algorithm, the necessary information can be found in our documentation regarding Customization.

Can I change something at the core of the GUI?

Sure, for more information, please take a look at our Contribution Guidelines.