.. NeuXus documentation master file, created for
   sphinx on Wed Jul 29 10:56:30 2020.
   Author: Simon Legeay (legeay.simon.sup@gmail.com)
   

Welcome to NeuXus' documentation!
=================================

NeuXus is a modular software written in Python that allows to easily create and execute pipelines in real time. NeuXus is specifically designed for BCI real-time processing and classification.

It offers a lot of possibilities, many basic functions are already implemented so that the first pipelines can be quickly created. For more specific functions, users can develop and use their own functions.

.. toctree::
   :maxdepth: 1
   :caption: Contents:

   usage
   tuto1
   tuto2
   contribute
   cite_us
   api


Install NeuXus
==============

NeuXus requires Python 3.7+, verify your Python version with:
::

   $ python --version

Install NeuXus with:
::

   $ pip install neuxus

To run your first pipeline, follow the tutorial :ref:`tutorial1`.


Vocabulary
==========

Many Nodes are available to build, please refer to the :ref:`api`.

.. image:: image/pipeline.png
  :width: 700
  :alt: Alternative text

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`