Skip to content

Commit

Permalink
Merge d019b54 into f2890ed
Browse files Browse the repository at this point in the history
  • Loading branch information
cbrnr committed Aug 12, 2015
2 parents f2890ed + d019b54 commit e34d376
Show file tree
Hide file tree
Showing 4 changed files with 41 additions and 26 deletions.
21 changes: 8 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,21 @@
[![Build Status](https://travis-ci.org/scot-dev/scot.svg?branch=master)](https://travis-ci.org/scot-dev/scot)
[![Coverage Status](https://coveralls.io/repos/scot-dev/scot/badge.svg?branch=master)](https://coveralls.io/r/scot-dev/scot?branch=master)

SCoT
====

EEG Source Connectivity Toolbox in Python
SCoT is a Python package for EEG/MEG source connectivity estimation.


Obtaining SCoT
--------------

Use the following command to fetch the sources:

git clone --recursive https://github.com/scot-dev/scot.git scot
`--recursive` tells git to check out the numpydoc submodule which is required for building the documentation.

The flag `--recursive` tells git to check out the numpydoc submodule, which is required for building the documentation.


Documentation
-------------
Documentation is available online at http://scot-dev.github.io/scot-doc/index.html
Documentation is available online at http://scot-dev.github.io/scot-doc/index.html.


Dependencies
Expand All @@ -31,14 +27,13 @@ Optional: matplotlib, scikit-learn

Examples
--------
To run the examples on Linux, invoke the following commands inside the SCoT main directory:

To run the examples on Linux invoke the following commands inside the SCoT main directory:

PYTHONPATH=. python examples/misc/connectivity.py
PYTHONPATH=. python examples/misc/connectivity.py

PYTHONPATH=. python examples/misc/timefrequency.py
PYTHONPATH=. python examples/misc/timefrequency.py

etc.


Note that as of March 3 2014 you need to get the example data from https://github.com/SCoT-dev/scot-data. The scotdata package must be on Python's search path.
Note that you need to obtain the example data from https://github.com/SCoT-dev/scot-data. The scot-data package must be on Python's search path.
1 change: 0 additions & 1 deletion VERSION
Original file line number Diff line number Diff line change
@@ -1,2 +1 @@
0.1.0

2 changes: 2 additions & 0 deletions setup.cfg
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
[bdist_wheel]
universal=1
43 changes: 31 additions & 12 deletions setup.py
Original file line number Diff line number Diff line change
@@ -1,17 +1,36 @@
#!/usr/bin/env python

from distutils.core import setup
from setuptools import setup
from codecs import open


versionfile = open('VERSION', 'r')
ver = versionfile.read().strip()
versionfile.close()
with open('VERSION', encoding='utf-8') as version:
ver = version.read().strip()

setup(name='scot',
version=ver,
description='Source Connectivity Toolbox',
author='Martin Billinger',
author_email='martin.billinger@tugraz.at',
url='https://github.com/scot-dev/scot',
packages=['scot', 'scot.eegtopo', 'scot.external'],
install_requires=['numpy >=1.7', 'scipy >=0.12'])
with open('README.md', encoding='utf-8') as readme:
long_description = readme.read()

setup(
name='scot',
version=ver,
description='EEG/MEG Source Connectivity Toolbox',
long_description=long_description,
url='https://github.com/scot-dev/scot',
author='SCoT Development Team',
author_email='scotdev@googlegroups.com',
license='MIT',
classifiers=[
'Development Status :: 4 - Beta',
'Intended Audience :: Science/Research',
'Topic :: Scientific/Engineering',
'License :: OSI Approved :: MIT License',
'Programming Language :: Python :: 2',
'Programming Language :: Python :: 2.7',
'Programming Language :: Python :: 3',
'Programming Language :: Python :: 3.2',
'Programming Language :: Python :: 3.3',
'Programming Language :: Python :: 3.4',
],
keywords='source connectivity EEG MEG ICA',
packages=['scot', 'scot.eegtopo', 'scot.external']
)

0 comments on commit e34d376

Please sign in to comment.