=================================
Welcome to spk2py's Documentation
=================================

.. note::
    spk2py is a Python-based framework for processing and analyzing electrophysiological spike data.
    It extracts spike waveforms from raw Spike2 files using the lower-level SonPy library, and then
    performs waveform extraction and spike sorting. It also provides a number of tools for analyzing
    the resulting spike data. Once spikes are sorted, users are able to post-process the spikes using
    plots for mahalanobis distance, ISI, and autocorrelograms. The spike data can also be exported to
    a variety of formats for further analysis in other programs.

.. toctree::
   :maxdepth: 2
   :caption: Getting Started
   :name: gettingstarted

   Installation <install>
   Guide <guide/index>
   API <api/index>
   Package <package/index>

Contribute
==========

1. Fork the repository.
2. Create your feature branch.
3. Commit your changes.
4. Open a pull request.

Contact
=======

- GitHub: https://github.com/flynnoconnell/spk2py
- Email: Flynnoconnell@gmail.com

For more in-depth information, consult the API documentation in `docs/api/autosort`.