Metadata-Version: 1.1
Name: yass-algorithm
Version: 0.6
Summary: YASS: Yet Another Spike Sorter
Home-page: https://github.com/paninski-lab/yass
Author: Peter Lee, Eduardo Blancas
Author-email: fkq8@blancas.io
License: Apache
Download-URL: https://github.com/paninski-lab/yass/archive/0.6.tar.gz
Description-Content-Type: UNKNOWN
Description: 
        YASS: Yet Another Spike Sorter
        ================================
        
        
        .. image:: https://travis-ci.org/paninski-lab/yass.svg?branch=master
            :target: https://travis-ci.org/paninski-lab/yass
        
        
        .. image:: https://readthedocs.org/projects/yass/badge/?version=latest
            :target: http://yass.readthedocs.io/en/latest/?badge=latest
        
        
        .. image:: https://badges.gitter.im/paninski-lab/yass.svg
            :target: https://gitter.im/paninski-lab/yass?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge
        
        
        **Note**: YASS is in an early stage of development. Although it is stable, it has only been tested
        with the data in our lab, but we are working to make it more flexible. Feel free to send
        feedback through `Gitter`_. Expect a lot of API changes in the near future.
        
        .. _Gitter: https://gitter.im/paninski-lab/yass
        
        Reference
        ---------
        
        Lee, J. et al. (2017). YASS: Yet another spike sorter. Neural Information Processing Systems. Available in biorxiv: https://www.biorxiv.org/content/early/2017/06/19/151928
        
        
        Installation
        ------------
        
        Installing the last stable version:
        
        
        .. code-block:: shell
        
           pip install yass-algorithm
        
        
        If you are feeling adventurous, you can install from the master branch:
        
        
        .. code-block:: shell
        
            pip install git+git://github.com/paninski-lab/yass@master
        
        Example
        -------
        
        Quick example of YASS using a sample of the neuropixel data from `Nick
        Steinmetz`_:
        
        .. _Nick Steinmetz: http://data.cortexlab.net/singlePhase3/
        
        .. code-block:: shell
        
            # install last stable version
            pip install yass-algorithm
        
            # clone repo to get the sample data
            git clone https://github.com/paninski-lab/yass
        
            # move to the examples folder and run yass in the sample data
            cd yass/examples
            yass sort config_sample.yaml
        
            # see the spike train
            cat data/spike_train.csv
        
        
        You can also use YASS in Python scripts. See the documentation for details.
        
        
        Documentation
        -------------
        
        Documentation hosted at `https://yass.readthedocs.io`_
        
        
        .. _https://yass.readthedocs.io: https://yass.readthedocs.io
        
        Running tests
        -------------
        
        To run tests and flake8 checks (from the root folder):
        
        .. code-block:: shell
        
            pip install -r requirements.txt
        
            pytest --flake8
        
        
        Building documentation
        ----------------------
        
        You need to install graphviz to build the graphs included in the
        documentation. On macOS:
        
        
        .. code-block:: shell
        
            brew install graphviz
        
        
        To build the docs (from the root folder):
        
        .. code-block:: shell
        
            pip install -r requirements.txt
        
            cd doc
            make html
        
        
        Contributors
        ------------
        
        `Peter Lee`_, `Eduardo Blancas`_, `Nishchal Dethe`_, `Shenghao Wu`_,
        `Hooshmand Shokri`_, `Calvin Tong`_
        
        .. _Peter Lee: https://github.com/pjl4303
        .. _Eduardo Blancas: https://blancas.io
        .. _Nishchal Dethe: https://github.com/nd2506
        .. _Shenghao Wu: https://github.com/ShenghaoWu
        .. _Hooshmand Shokri: https://github.com/hooshmandshr
        .. _Calvin Tong: https://github.com/calvinytong
        
Platform: UNKNOWN
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: Implementation :: CPython
