Brain Imaging Analysis Kit
Switch branches/tags
Nothing to show
Clone or download
mihaic dev: Fix Pip installation during Conda build (#395)
Our dependency installation method was not supported anymore:
conda/conda-build#3109

Note to self: read release notes first when debugging.
Latest commit 8d931d6 Dec 14, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.conda dev: Fix Pip installation during Conda build (#395) Dec 14, 2018
brainiak WIP: Revamped ISC analyses with additional statistical tests (#384) Dec 7, 2018
docs Add release notes for v0.8 (#390) Nov 9, 2018
examples WIP: Revamped ISC analyses with additional statistical tests (#384) Dec 7, 2018
tests WIP: Revamped ISC analyses with additional statistical tests (#384) Dec 7, 2018
.codecov.yml dev: Add coverage variation to deal with flakiness (#335) Mar 19, 2018
.gitignore dev: Add release instructions for Docker and docs (#334) Mar 19, 2018
.travis.yml dev: Reduce number of Travis MacOS builds to 2 (#346) Mar 21, 2018
CONTRIBUTING.rst dev: Add release instructions for Docker and docs (#334) Mar 19, 2018
Dockerfile factoranalysis: Add HTFA tutorial (#271) Jan 18, 2018
LICENSE Add Apache license and headers Jul 7, 2016
NEWS.rst Add release notes for v0.8 (#390) Nov 9, 2018
README.rst dev: Add Conda packaging (#328) Feb 13, 2018
pr-check.sh dev: Add workaround for multiple OpenMP libraries (#378) Aug 31, 2018
pyproject.toml docs: Add release notes (#248) Jul 28, 2017
requirements-dev.txt dev: Add Conda packaging (#328) Feb 13, 2018
run-checks.sh dev: Run flake8 on test code (#258) Aug 14, 2017
run-tests.sh dev: Fix TensorFlow workaround for our Jenkins server (#359) Apr 30, 2018
setup.cfg dev: Configure coverage for multiprocessing (#327) Feb 3, 2018
setup.py Fit parameters (#372) Sep 2, 2018

README.rst

Brain Imaging Analysis Kit

https://travis-ci.org/brainiak/brainiak.svg?branch=master Join the chat at https://gitter.im/brainiak/brainiak

The Brain Imaging Analysis Kit is a package of Python modules useful for neuroscience, primarily focused on functional Magnetic Resonance Imaging (fMRI) analysis.

The package was originally created by a collaboration between Intel and the Princeton Neuroscience Institute (PNI).

To reduce verbosity, we may refer to the Brain Imaging Analysis Kit using the BrainIAK abbreviation. Whenever lowercase spelling is used (e.g., Python package name), we use brainiak.

Quickstart

If you have Conda:

conda install -c brainiak -c defaults -c conda-forge brainiak

Otherwise, or if you want to compile from source, install the requirements (see docs/installation) and then install from PyPI:

python3 -m pip install brainiak

Note that we do not support Windows.

Docker

You can also test BrainIAK without installing it using Docker:

docker pull brainiak/brainiak
docker run -it -p 8888:8888 -v brainiak:/mnt --name demo brainiak/brainiak

To run Jupyter notebooks in the running container, try:

python3 -m notebook --allow-root --no-browser --ip=0.0.0.0

Then visit http://localhost:8888 in your browser and enter the token. Protip: run screen before running the notebook command.

Note that we do not support MPI execution using Docker containers and that performance will not be optimal.

Support

If you have a question or feedback, chat with us on Gitter or email our list at brainiak@googlegroups.com. If you find a problem with BrainIAK, you can also open an issue on GitHub.

Examples

We include BrainIAK usage examples in the examples directory of the code repository, e.g., funcalign/srm_image_prediction_example.ipynb.

To run the examples, download an archive of the latest BrainIAK release from GitHub. Note that we only support the latest release at this moment, so make sure to upgrade your BrainIAK installation.

Documentation

The documentation is available at http://brainiak.org/docs.

Contributing

We welcome contributions. Have a look at the issues labeled "easy" for starting contribution ideas. Please read the guide in CONTRIBUTING.rst first.

Citing

Please cite BrainIAK in your publications as: "Brain Imaging Analysis Kit, http://brainiak.org." Additionally, if you use RRIDs to identify resources, please mention BrainIAK as "Brain Imaging Analysis Kit, RRID:SCR_014824". Finally, please cite the publications referenced in the documentation of the BrainIAK modules you use, e.g., SRM.