This project contains graphical user interface (GUI) addons that complement the
scripting functionality in mne-python, mne-bids and other mne projects
for tasks that require a user to interact with data, usually that is 3D, in order
for them to be accomplished. For example:
- Locating intracranial electrode contacts from a computed tomography (CT) or magnetic resonance (MR) scan
- Viewing time-frequency source estimate data
Please see https://mne.tools/mne-gui-addons/ for installation instructions, tutorials, and examples for a wide variety of topics, contributing guidelines, and an API reference.
If you find a bug or have an idea for a new feature that should be added, please use the issue tracker of our GitHub repository.
To install the latest stable version of MNE-GUI-Addons with minimal dependencies only, use pip in a terminal:
$ pip install --upgrade mne-gui-addonsTo install the latest development version of MNE-Python using pip, open a terminal and type:
$ pip install --upgrade git+https://github.com/mne-tools/mne-gui-addons@mainTo clone the repository with git, open a terminal and type:
$ git clone https://github.com/mne-tools/mne-gui-addons.gitPlease see the contributing guidelines on our documentation website.
MNE-GUI-Addons is BSD-licensed (BSD-3-Clause):
This software is OSI Certified Open Source Software. OSI Certified is a certification mark of the Open Source Initiative.
Copyright (c) 2011-2023, authors of MNE-Python. All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
- Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
- Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
- Neither the names of MNE-Python authors nor the names of any contributors may be used to endorse or promote products derived from this software without specific prior written permission.
This software is provided by the copyright holders and contributors "as is" and any express or implied warranties, including, but not limited to, the implied warranties of merchantability and fitness for a particular purpose are disclaimed. In no event shall the copyright owner or contributors be liable for any direct, indirect, incidental, special, exemplary, or consequential damages (including, but not limited to, procurement of substitute goods or services; loss of use, data, or profits; or business interruption) however caused and on any theory of liability, whether in contract, strict liability, or tort (including negligence or otherwise) arising in any way out of the use of this software, even if advised of the possibility of such damage.