Metadata-Version: 1.1
Name: yass-algorithm
Version: 0.2
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.2.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
        
        State-of-the-art spike sorting.
        
        **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
        
        
        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
        
            # clone the repo and move to the main folder
            git clone https://github.com/paninski-lab/yass
            cd yass
        
            # install package (this is the same as running
            # pip install git+https://github.com/paninski-lab/yass)
            pip install .
        
            # move to the examples folder and run yass in the sample data
            cd examples
            yass 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
        -------------
        
        .. code-block:: shell
        
            pytest
        
        
        Building documentation
        ----------------------
        
        You need to install graphviz to build the graphs included in the documentation. On macOS:
        
        
        .. code-block:: shell
        
            brew install graphviz
        
        
        .. code-block:: shell
        
            cd doc
            make [format]
        
        
        Maintainers
        -----------
        
        `Peter Lee`_, `Eduardo Blancas`_
        
        
        
        .. _Peter Lee: https://github.com/pjl4303
        .. _Eduardo Blancas: https://edublancas.github.io/
        
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
