.. capcalc documentation master file

Capcalc
==========
capcalc is a suite of python programs used to perform coactivation
pattern analysis on time series data. It uses K-Means clustering to find
a set of “activation states” that represent the covarying patterns in
the data.

HTML documentation is here: http://capcalc.readthedocs.io/en/latest/

.. image:: https://img.shields.io/pypi/v/capcalc.svg
   :target: https://pypi.python.org/pypi/capcalc/
.. image:: https://img.shields.io/pypi/pyversions/capcalc.svg
   :target: https://pypi.python.org/pypi/capcalc/
.. image:: https://img.shields.io/badge/License-Apache%202.0-blue.svg
   :target: https://opensource.org/licenses/Apache-2.0
.. image:: https://readthedocs.org/projects/capcalc/badge/?version=latest
   :target: http://capcalc.readthedocs.io/en/dev/?badge=latest
.. image:: https://zenodo.org/badge/83364565.svg
   :target: https://zenodo.org/badge/latestdoi/83364565
.. image:: https://img.shields.io/badge/NIH-R01--NS097512--01A1-yellowgreen.svg
   :target: http://grantome.com/grant/NIH/R01-NS097512-01A1

Citing capcalc
-------------------

  Frederick, B, capcalc [Computer Software] (2016-2022). Available from
  https://github.com/bbfrederick/capcalc. doi:`10.5281/zenodo.7035806`_

.. _10.5281/zenodo.7035806: https://doi.org/10.5281/zenodo.7035806

Contents
========
.. toctree::
   :maxdepth: 2

   introduction.rst
   installation.rst
   usage.rst


.. toctree::
   :maxdepth: 2
   :caption: History:

   whats_new.rst


Indices and tables
==================

* :ref:`genindex`
* :ref:`search`