neuroidss/timeflux

Acquisition and real-time processing of biosignals

Timeflux

Timeflux is a free and open-source framework for the acquisition and real-time processing of biosignals. Use it to bootstrap your research, build brain-computer interfaces, closed-loop biofeedback applications, interactive installations, and more. Written in Python, it works on Linux, MacOS and Windows. Made for researchers and hackers alike.

Installation

First, get the Anaconda distribution.

You can then install Timeflux and its dependencies:

$ curl -O https://raw.githubusercontent.com/timeflux/timeflux/master/environment.yml
$ conda install pip
$ conda env create -f environment.yml
$ conda activate timeflux

Getting started

Read the documentation.

Examples

The following basic example illustrates the main principles:

$ curl -O https://raw.githubusercontent.com/timeflux/timeflux/master/test/graphs/test.yaml
$ timeflux --debug test.yaml

If you also install timeflux_ui, the data can be visualized:

$ curl -O https://raw.githubusercontent.com/timeflux/timeflux/master/test/graphs/ui.yaml
$ timeflux ui.yaml

You can then monitor the signals in your browser.

More examples of Timeflux graphs are available in test/graphs.