Metadata-Version: 2.1
Name: bdpy
Version: 0.17
Summary: Brain decoder toolbox for Python
Home-page: https://github.com/KamitaniLab/bdpy
Author: Shuntaro C. Aoki
Author-email: brainliner-admin@atr.jp
Maintainer: Shuntaro C. Aoki
Maintainer-email: brainliner-admin@atr.jp
License: MIT
Keywords: neuroscience,neuroimaging,brain decoding,fmri,machine learning
Platform: UNKNOWN
Description-Content-Type: text/markdown
Requires-Dist: numpy
Requires-Dist: scipy
Requires-Dist: scikit-learn
Requires-Dist: h5py
Requires-Dist: hdf5storage
Requires-Dist: pyyaml

# BdPy

[![PyPI version](https://badge.fury.io/py/bdpy.svg)](https://badge.fury.io/py/bdpy)
[![GitHub license](https://img.shields.io/github/license/KamitaniLab/bdpy)](https://github.com/KamitaniLab/bdpy/blob/master/LICENSE)

Python package for brain decoding analysis

## Requirements

- Python 2.7, 3.6, or later
- numpy
- scipy
- scikit-learn
- h5py
- hdf5storage
- pyyaml

### Optional requirements

- `dataform` module
    - pandas
- `dl.caffe` module
    - Caffe
    - Pillow
    - tqdm
- `dl.torch` module
    - PyTorch
    - Pillow
- `fig` module
    - matplotlib
    - Pillow
- `mri` module
    - nipy
    - nibabel
    - pandas
- `recon.torch` module
    - PyTorch
    - Pillow

## Installation

Latest stable release:

``` shell
$ pip install bdpy
```

To install the latest development version ("master" branch of the repository), please run the following command.

```shell
$ pip install git+https://github.com/KamitaniLab/bdpy.git
```

## Packages

- bdata: BdPy data format (BData) core package
- dataform: Utilities for various data format
- distcomp: Distributed computation utilities
- dl: Deep learning utilities
- feature: Utilities for DNN features
- fig: Utilities for figure creation
- ml: Machine learning utilities
- mri: MRI utilities
- opendata: Open data utilities
- preproc: Utilities for preprocessing
- recon: Reconstruction methods
- stats: Utilities for statistics
- util: Miscellaneous utilities

## BdPy data format

BdPy data format (or BrainDecoderToolbox2 data format; BData) consists of two variables: dataset and metadata. **dataset** stores brain activity data (e.g., voxel signal value for fMRI data), target variables (e.g., ID of stimuli for vision experiments), and additional information specifying experimental design (e.g., run and block numbers for fMRI experiments). Each row corresponds to a single 'sample', and each column representes either single feature (voxel), target, or experiment design information. **metadata** contains data describing meta-information for each column in dataset.

See [BData API examples](https://github.com/KamitaniLab/bdpy/blob/master/docs/bdata_api_examples.md) for useage of BData.

## Developers

- Shuntaro C. Aoki (Kyoto Univ)


