.. MEArec documentation master file, created by
   sphinx-quickstart on Fri Jan 25 11:59:06 2019.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to MEArec's documentation!
======================================

Python package for fast and customuzable biophysical simulation of extracellular recordings.
MEArec also implements a command-line interface. From terminal just run :code:`mearec` to show the list of available commands.

Contents
========

The following sections will guide you through definitions and handling of MEA models, as well as electrical stimulation
and plotting functions.

.. toctree::
   :maxdepth: 1

   overview
   installation
   generate_templates
   generate_recordings
   cli
   usage
   api
   whatisnew

For further details, please refer to the article:

`MEArec: A Fast and Customizable Testbench Simulator for Ground-truth Extracellular Spiking Activity <https://doi.org/10.1007/s12021-020-09467-7>`_

Contact
=======

If you have questions or comments, contact Alessio Buccino: alessiop.buccino@gmail.com