Skip to content

MNE-CAMCAN for processing the Cambridge Centre for Ageing and Neuroscience (Cam-CAN) MEG dataset using MNE-Python

License

Notifications You must be signed in to change notification settings

SherazKhan/mne-camcan

Repository files navigation

Travis_ Zenodo_ Codecov_

MNE-CAMCAN

We provide Python tools for seamless integration of MEG data from the Cambridge Centre for Ageing and Neuroscience (Cam-CAN) Database into the Python ecosystem. In only a few lines of code, complex data retrieval requests can be readily executed on the resources from this neuroimaging reference dataset. Raw CAMCAN data are translated into actionable MNE objects that we know and love. MNE-CAMCAN abstracts away difficulties due to diverging coordinate systems, distributed information, and file format conventions. Providing a simple and consistent access to HCP MEG data will facilitate emergence of standardized data analysis practices. By building on the MNE software package, MNE-HCP naturally supplements a fast growing stack of Python data science toolkits.

Fast interface to MEG data

Scope and Disclaimer

This code is under active research-driven development. The API is still changing, but is getting closer to a stable release.

Note

For now please consider the following caveats:

  • We only intend to support a subset of the files shipped with CAMCAN.
  • Specifically, for now it is not planned to support io and processing for any outputs of the CAMCAN source space pipelines.
  • This library breaks with some of MNE conventions in order to make the camcan outputs compatible with MNE.

Installation

We recommend the Anaconda Python distribution, which comes with the necessary dependencies. Alternatively, to install mne-camcan, you first need to install its dependencies:

$ pip install numpy matplotlib scipy scikit-learn mne joblib pandas

Then clone the repository:

$ git clone http://github.com/mne-tools/mne-camcan

and finally run setup.py to install the package:

$ cd mne-camcan/
$ python setup.py install

If you do not have admin privileges on the computer, use the --user flag with setup.py.

Alternatively, for a devoloper install based on symbolic links (which simplifies keeping up with code changes), do:

$ cd mne-camcan/
$ python setup.py develop

To check if everything worked fine, you can do:

$ python -c 'import camcan'

and it should not give any error messages.

Dependencies

The following main and additional dependencies are required to use MNE-camcan:

  • MNE-Python master branch
  • the MNE-Python dependencies, specifically
    • scipy
    • numpy
    • matplotlib
  • scikit-learn (optional)

Acknowledgements

This project is supported by the Amazon Webservices Research grant issued to Denis A. Engemann and Sheraz Khan.

We acknowledge support by Alex Gramfort and Eric Larson for discussions, inputs and help with finding the best way to map CAMCAN data to the MNE world.

About

MNE-CAMCAN for processing the Cambridge Centre for Ageing and Neuroscience (Cam-CAN) MEG dataset using MNE-Python

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published