Metadata-Version: 2.1
Name: brainbox
Version: 0.0.2
Summary: Simplifying the life of a computational neuroscientist.
Home-page: https://github.com/webstorms/BrainBox
Author: Luke Taylor
Author-email: webstorms@gmail.com
Project-URL: Bug Tracker, https://github.com/webstorms/BrainBox/issues
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE.md

![](BrainBox.png?raw=true)

<h4 align="center">Simplifying the life of a computational neuroscientist.</h4>

<p align="center">
  <a href="https://badge.fury.io/js/electron-markdownify">
    <img src="https://anaconda.org/anaconda/conda-build/badges/installer/conda.svg">
  </a>
  <a href="https://badge.fury.io/js/electron-markdownify">
    <img src="https://img.shields.io/badge/License-MIT-blue.svg">
  </a>
</p>

<p align="center">
  <a href="#key-features">Key features</a> •
  <a href="#installation">Installation</a> •
  <a href="#getting-started">Getting started</a> •
<a href="#roadmap">Roadmap</a> •
  <a href="#license">License</a>
</p>

## Key features

* Model construction (bookkeeping, snn layers)
* Model training (different flavours, bookkeeping, customisability/flexibility)
* Model validation (GPU optimised metrics e.g. cc, ccnorm, rdm, deviation)
* Model inspection (virtual e-phys)
* Datasets (plug and play format)


## Installation

```bash
# Clone this repository
$ git clone https://github.com/webstorms/BrainBox.git
```

## Getting started

* [Building and training a model](https://github.com/webstorms/BrainBox/blob/main/notebooks/Predicting%20neural%20responses.ipynb)
* [Estimating model RFs and fitting gabors](https://github.com/webstorms/BrainBox/blob/main/notebooks/Receptive%20field%20analysis.ipynb)

## Roadmap

- Create conda build
- Make all datasets publicly available (and including more datasets)
- More notebook tutorials
- Finish e-phys pipeline

## License

BrainBox has a MIT license, as found in the LICENSE file.
