.. connectivipy documentation master file, created by
   sphinx-quickstart on Sat Jan 31 10:24:42 2015.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

ConnectiviPy documentation
========================================
Python connectivity module. It is a part of GSOC 2015 project. 

You can find it and download from `GitHub
<https://github.com/dokato/connectivipy>`_.

*Connectivity estimation is one of the most important problem in EEG/MEG 
studies. Many estimators work correctly in different applications, so it's
convenient to have them all in one tool. ConnectiviPy 
is light and  extendable python module open for many data formats. In
opposite to other packages it allows you to work with all types of data,
not only biomedical. Calculations base on numpy and scipy what provides
good efficiency.*

Tested under Python 3.6 and 3.8.

Contents:
#########

.. toctree::
    data
    conn
    mvar

Tutorials:

.. toctree::
    :maxdepth: 1

    install
    tutorial

Questions and bug reports
#########################

If you have any questions or want to report a bug, the easiest way
is to post a new issue on `GitHub issues
<https://github.com/dokato/connectivipy/issues>`_.


Credits:
########

* Dominik Krzemiński
* Maciej Kamiński (scientific lead)