Maybrain

Maybrain is a Python package for analysing and visualising brain connectome and related data.

Dependencies

To run Maybrain you will need a Python 3.5 installation and several other packages on which parts of the code depend. The following are required for analysis:

• Numpy
• NetworkX

The following is required for plotting functions:

• Matplotlib
• Nilearn

The following provides some extra functionality for input of certain data types:

• NiBabel
• Mayavi
• bctpy

If you are not familiar with Python, or you don't want to manually install and deal with each package separately, it is recommended that you install a pre-packaged version that will include most of the above, for example Anaconda. Installation for each package can be found on the individual websites, but if you want to use Anaconda you will find instructions in our documentation page.

Installation

To install, simply run setup.py throughout pip:

$ pip install .

If you want more detailed instructions about installing maybrain using Anaconda, please go to our Wiki pages.

Documentation

For a detailed documentation, with usage examples and explanations, please go to our Wiki pages.

Contributing

The authors are happy for developers to extend, customise, improve or simply to create an issue. We will create an innovative and meaningful hall of fame for anyone contributing a bug-fix and promise to buy you a beer (or acceptable non-alcoholic alternative) when we meet.

Submitting a Pull Request

1. Fork it.
2. Create a branch (git checkout -b my_maybrain)
3. Commit your changes (git commit -am "Added message type")
4. Push to the branch (git push origin my_maybrain)
5. Open a Pull Request
6. Enjoy a refreshing beverage and wait

Credits

Maybrain was originally written by Timothy Rittman and Martyn Rittman, but with substantial improvements and updates from Tiago Azevedo.

Licence

Maybrain is licensed under the Apache License, Version 2.0. See LICENSE for the full license text.