Metadata-Version: 2.1
Name: MEArec
Version: 1.8.0
Summary: Fast and customizable simulation of extracellular recordings on Multi-Electrode-Arrays.
Home-page: https://github.com/alejoe91/MEArec
Author: Alessio Buccino
Author-email: alessiob@ifi.uio.no
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)  
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy
Requires-Dist: click
Requires-Dist: pyyaml
Requires-Dist: matplotlib
Requires-Dist: h5py
Requires-Dist: neo
Requires-Dist: quantities
Requires-Dist: elephant
Requires-Dist: MEAutility
Requires-Dist: joblib
Requires-Dist: lazy-ops

[![Build Status](https://github.com/alejoe91/MEArec/actions/workflows/python-package.yml/badge.svg)](https://github.com/alejoe91/MEArec/actions/workflows/python-package.yml/badge.svg) [![PyPI version](https://badge.fury.io/py/MEArec.svg)](https://badge.fury.io/py/MEArec)

# MEArec: Fast and customizable simulation of extracellular recordings on Multi-Electrode-Arrays

MEArec is a package for generating biophysical extracellular neural recording on Multi-Electrode Arrays (MEA). The recording generations combines a Extracellular Action Potentials (EAP) templates generation and spike trains generation. The recordings are built by convoluting and modulating EAP templates with spike trains and adding noise.

To clone this repo open your terminal and run:

`git clone https://github.com/alejoe91/MEArec.git`

## Installation

The MEArec package can be installed with:

```
pip install MEArec
```
or, from the cloned folder:

```
python setup.py develop
```

## Documentation

The MEArec detailed documentation is here: https://mearec.readthedocs.io/en/latest/

### Reference

For further information please refer to the open-access Neuroinformatics article: https://doi.org/10.1007/s12021-020-09467-7

If you use the software, please cite:
```
@article{buccino2020mearec,
  title={Mearec: a fast and customizable testbench simulator for ground-truth extracellular spiking activity},
  author={Buccino, Alessio Paolo and Einevoll, Gaute Tomas},
  journal={Neuroinformatics},
  pages={1--20},
  year={2020},
  publisher={Springer}
}
```


