.. -*- mode: rst -*-
|MNE|
MNE-Python
==========
MNE-Python is an open-source Python package for exploring,
visualizing, and analyzing human neurophysiological data such as MEG, EEG, sEEG,
ECoG, and more. It includes modules for data input/output, preprocessing,
visualization, source estimation, time-frequency analysis, connectivity analysis,
machine learning, statistics, and more.
Documentation
^^^^^^^^^^^^^
`Documentation`_ for MNE-Python encompasses installation instructions, tutorials,
and examples for a wide variety of topics, contributing guidelines, and an API
reference.
Forum
^^^^^^
The `user forum`_ is the best place to ask questions about MNE-Python usage or
the contribution process. The forum also features job opportunities and other
announcements.
If you find a bug or have an idea for a new feature that should be added to
MNE-Python, please use the
`issue tracker <https://github.com/mne-tools/mne-python/issues/new/choose>`__ of
our GitHub repository.
Installation
^^^^^^^^^^^^
To install the latest stable version of MNE-Python with minimal dependencies
only, use pip_ in a terminal:
.. code-block:: console
$ pip install --upgrade mne
The current MNE-Python release requires Python 3.9 or higher. MNE-Python 0.17
was the last release to support Python 2.7.
For more complete instructions, including our standalone installers and more
advanced installation methods, please refer to the `installation guide`_.
Get the development version
^^^^^^^^^^^^^^^^^^^^^^^^^^^
To install the latest development version of MNE-Python using pip_, open a
terminal and type:
.. code-block:: console
$ pip install --upgrade https://github.com/mne-tools/mne-python/archive/refs/heads/main.zip
To clone the repository with `git <https://git-scm.com/>`__, open a terminal
and type:
.. code-block:: console
$ git clone https://github.com/mne-tools/mne-python.git
Dependencies
^^^^^^^^^^^^
The minimum required dependencies to run MNE-Python are:
- `Python <https://www.python.org>`__ ≥ 3.9
- `NumPy <https://numpy.org>`__ ≥ 1.23
- `SciPy <https://scipy.org>`__ ≥ 1.9
- `Matplotlib <https://matplotlib.org>`__ ≥ 3.6
- `Pooch <https://www.fatiando.org/pooch/latest/>`__ ≥ 1.5
- `tqdm <https://tqdm.github.io>`__
- `Jinja2 <https://palletsprojects.com/p/jinja/>`__
- `decorator <https://github.com/micheles/decorator>`__
- `lazy_loader <https://pypi.org/project/lazy_loader/>`__
For full functionality, some functions require:
- `scikit-learn <https://scikit-learn.org/stable/>`__ ≥ 1.1
- `Joblib <https://joblib.readthedocs.io/en/latest/index.html>`__ ≥ 0.15 (for parallelization)
- `mne-qt-browser <https://github.com/mne-tools/mne-qt-browser>`__ ≥ 0.5 (for fast raw data visualization)
- `Qt <https://www.qt.io>`__ ≥ 5.15 via one of the following bindings (for fast raw data visualization and interactive 3D visualization):
- `PySide6 <https://doc.qt.io/qtforpython-6/>`__ ≥ 6.0
- `PyQt6 <https://www.riverbankcomputing.com/software/pyqt/>`__ ≥ 6.0
- `PyQt5 <https://www.riverbankcomputing.com/software/pyqt/>`__ ≥ 5.15
- `Numba <https://numba.pydata.org>`__ ≥ 0.54.0
- `NiBabel <https://nipy.org/nibabel/>`__ ≥ 3.2.1
- `OpenMEEG <https://openmeeg.github.io>`__ ≥ 2.5.6
- `pandas <https://pandas.pydata.org>`__ ≥ 1.3.2
- `Picard <https://pierreablin.github.io/picard/>`__ ≥ 0.3
- `CuPy <https://cupy.dev>`__ ≥ 9.0.0 (for NVIDIA CUDA acceleration)
- `DIPY <https://dipy.org>`__ ≥ 1.4.0
- `imageio <https://imageio.readthedocs.io/en/stable/>`__ ≥ 2.8.0
- `PyVista <https://pyvista.org>`__ ≥ 0.32 (for 3D visualization)
- `PyVistaQt <https://qtdocs.pyvista.org>`__ ≥ 0.4 (for 3D visualization)
- `mffpy <https://github.com/BEL-Public/mffpy>`__ ≥ 0.5.7
- `h5py <https://www.h5py.org>`__
- `h5io <https://github.com/h5io/h5io>`__
- `pymatreader <https://pymatreader.readthedocs.io/en/latest/>`__
Contributing
^^^^^^^^^^^^
Please see the `contributing guidelines <https://mne.tools/dev/development/contributing.html>`__ on our documentation website.
About
^^^^^
+---------+------------+----------------+
| CI | |Codecov| | |Bandit| |
+---------+------------+----------------+
| Package | |PyPI| | |conda-forge| |
+---------+------------+----------------+
| Docs | |Docs| | |Discourse| |
+---------+------------+----------------+
| Meta | |Zenodo| | |OpenSSF| |
+---------+------------+----------------+
License
^^^^^^^
MNE-Python is licensed under the BSD-3-Clause license.
.. _Documentation: https://mne.tools/dev/
.. _user forum: https://mne.discourse.group
.. _installation guide: https://mne.tools/dev/install/index.html
.. _pip: https://pip.pypa.io/en/stable/
.. |PyPI| image:: https://img.shields.io/pypi/dm/mne.svg?label=PyPI
:target: https://pypi.org/project/mne/
.. |conda-forge| image:: https://img.shields.io/conda/dn/conda-forge/mne.svg?label=Conda
:target: https://anaconda.org/conda-forge/mne
.. |Docs| image:: https://img.shields.io/badge/Docs-online-green?label=Documentation
:target: https://mne.tools/dev/
.. |Zenodo| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.592483.svg
:target: https://doi.org/10.5281/zenodo.592483
.. |Discourse| image:: https://img.shields.io/discourse/status?label=Forum&server=https%3A%2F%2Fmne.discourse.group%2F
:target: https://mne.discourse.group/
.. |Codecov| image:: https://img.shields.io/codecov/c/github/mne-tools/mne-python?label=Coverage
:target: https://codecov.io/gh/mne-tools/mne-python
.. |Bandit| image:: https://img.shields.io/badge/Security-Bandit-yellow.svg
:target: https://github.com/PyCQA/bandit
.. |OpenSSF| image:: https://www.bestpractices.dev/projects/7783/badge
:target: https://www.bestpractices.dev/projects/7783
.. |MNE| image:: https://mne.tools/dev/_static/mne_logo_gray.svg
:target: https://mne.tools/dev/
Raw data
{
"_id": null,
"home_page": null,
"name": "mne",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "Dan McCloy <dan@mccloy.info>",
"keywords": "ECoG, EEG, MEG, brain, fNIRS, neuroimaging, neuroscience",
"author": null,
"author_email": "Alexandre Gramfort <alexandre.gramfort@inria.fr>",
"download_url": "https://files.pythonhosted.org/packages/49/95/7f452591f863ca9d5a98b171ca6d2b3c357e94ca02e02a87149776a7db8e/mne-1.8.0.tar.gz",
"platform": null,
"description": ".. -*- mode: rst -*-\n\n|MNE|\n\nMNE-Python\n==========\n\nMNE-Python is an open-source Python package for exploring,\nvisualizing, and analyzing human neurophysiological data such as MEG, EEG, sEEG,\nECoG, and more. It includes modules for data input/output, preprocessing,\nvisualization, source estimation, time-frequency analysis, connectivity analysis,\nmachine learning, statistics, and more.\n\n\nDocumentation\n^^^^^^^^^^^^^\n\n`Documentation`_ for MNE-Python encompasses installation instructions, tutorials,\nand examples for a wide variety of topics, contributing guidelines, and an API\nreference.\n\n\nForum\n^^^^^^\n\nThe `user forum`_ is the best place to ask questions about MNE-Python usage or\nthe contribution process. The forum also features job opportunities and other\nannouncements.\n\nIf you find a bug or have an idea for a new feature that should be added to\nMNE-Python, please use the\n`issue tracker <https://github.com/mne-tools/mne-python/issues/new/choose>`__ of\nour GitHub repository.\n\n\nInstallation\n^^^^^^^^^^^^\n\nTo install the latest stable version of MNE-Python with minimal dependencies\nonly, use pip_ in a terminal:\n\n.. code-block:: console\n\n $ pip install --upgrade mne\n\nThe current MNE-Python release requires Python 3.9 or higher. MNE-Python 0.17\nwas the last release to support Python 2.7.\n\nFor more complete instructions, including our standalone installers and more\nadvanced installation methods, please refer to the `installation guide`_.\n\n\nGet the development version\n^^^^^^^^^^^^^^^^^^^^^^^^^^^\n\nTo install the latest development version of MNE-Python using pip_, open a\nterminal and type:\n\n.. code-block:: console\n\n $ pip install --upgrade https://github.com/mne-tools/mne-python/archive/refs/heads/main.zip\n\nTo clone the repository with `git <https://git-scm.com/>`__, open a terminal\nand type:\n\n.. code-block:: console\n\n $ git clone https://github.com/mne-tools/mne-python.git\n\n\nDependencies\n^^^^^^^^^^^^\n\nThe minimum required dependencies to run MNE-Python are:\n\n- `Python <https://www.python.org>`__ \u2265 3.9\n- `NumPy <https://numpy.org>`__ \u2265 1.23\n- `SciPy <https://scipy.org>`__ \u2265 1.9\n- `Matplotlib <https://matplotlib.org>`__ \u2265 3.6\n- `Pooch <https://www.fatiando.org/pooch/latest/>`__ \u2265 1.5\n- `tqdm <https://tqdm.github.io>`__\n- `Jinja2 <https://palletsprojects.com/p/jinja/>`__\n- `decorator <https://github.com/micheles/decorator>`__\n- `lazy_loader <https://pypi.org/project/lazy_loader/>`__\n\nFor full functionality, some functions require:\n\n- `scikit-learn <https://scikit-learn.org/stable/>`__ \u2265 1.1\n- `Joblib <https://joblib.readthedocs.io/en/latest/index.html>`__ \u2265 0.15 (for parallelization)\n- `mne-qt-browser <https://github.com/mne-tools/mne-qt-browser>`__ \u2265 0.5 (for fast raw data visualization)\n- `Qt <https://www.qt.io>`__ \u2265 5.15 via one of the following bindings (for fast raw data visualization and interactive 3D visualization):\n\n - `PySide6 <https://doc.qt.io/qtforpython-6/>`__ \u2265 6.0\n - `PyQt6 <https://www.riverbankcomputing.com/software/pyqt/>`__ \u2265 6.0\n - `PyQt5 <https://www.riverbankcomputing.com/software/pyqt/>`__ \u2265 5.15\n\n- `Numba <https://numba.pydata.org>`__ \u2265 0.54.0\n- `NiBabel <https://nipy.org/nibabel/>`__ \u2265 3.2.1\n- `OpenMEEG <https://openmeeg.github.io>`__ \u2265 2.5.6\n- `pandas <https://pandas.pydata.org>`__ \u2265 1.3.2\n- `Picard <https://pierreablin.github.io/picard/>`__ \u2265 0.3\n- `CuPy <https://cupy.dev>`__ \u2265 9.0.0 (for NVIDIA CUDA acceleration)\n- `DIPY <https://dipy.org>`__ \u2265 1.4.0\n- `imageio <https://imageio.readthedocs.io/en/stable/>`__ \u2265 2.8.0\n- `PyVista <https://pyvista.org>`__ \u2265 0.32 (for 3D visualization)\n- `PyVistaQt <https://qtdocs.pyvista.org>`__ \u2265 0.4 (for 3D visualization)\n- `mffpy <https://github.com/BEL-Public/mffpy>`__ \u2265 0.5.7\n- `h5py <https://www.h5py.org>`__\n- `h5io <https://github.com/h5io/h5io>`__\n- `pymatreader <https://pymatreader.readthedocs.io/en/latest/>`__\n\n\nContributing\n^^^^^^^^^^^^\n\nPlease see the `contributing guidelines <https://mne.tools/dev/development/contributing.html>`__ on our documentation website.\n\n\nAbout\n^^^^^\n\n+---------+------------+----------------+\n| CI | |Codecov| | |Bandit| |\n+---------+------------+----------------+\n| Package | |PyPI| | |conda-forge| |\n+---------+------------+----------------+\n| Docs | |Docs| | |Discourse| |\n+---------+------------+----------------+\n| Meta | |Zenodo| | |OpenSSF| |\n+---------+------------+----------------+\n\n\nLicense\n^^^^^^^\n\nMNE-Python is licensed under the BSD-3-Clause license.\n\n\n.. _Documentation: https://mne.tools/dev/\n.. _user forum: https://mne.discourse.group\n.. _installation guide: https://mne.tools/dev/install/index.html\n.. _pip: https://pip.pypa.io/en/stable/\n\n.. |PyPI| image:: https://img.shields.io/pypi/dm/mne.svg?label=PyPI\n :target: https://pypi.org/project/mne/\n\n.. |conda-forge| image:: https://img.shields.io/conda/dn/conda-forge/mne.svg?label=Conda\n :target: https://anaconda.org/conda-forge/mne\n\n.. |Docs| image:: https://img.shields.io/badge/Docs-online-green?label=Documentation\n :target: https://mne.tools/dev/\n\n.. |Zenodo| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.592483.svg\n :target: https://doi.org/10.5281/zenodo.592483\n\n.. |Discourse| image:: https://img.shields.io/discourse/status?label=Forum&server=https%3A%2F%2Fmne.discourse.group%2F\n :target: https://mne.discourse.group/\n\n.. |Codecov| image:: https://img.shields.io/codecov/c/github/mne-tools/mne-python?label=Coverage\n :target: https://codecov.io/gh/mne-tools/mne-python\n\n.. |Bandit| image:: https://img.shields.io/badge/Security-Bandit-yellow.svg\n :target: https://github.com/PyCQA/bandit\n\n.. |OpenSSF| image:: https://www.bestpractices.dev/projects/7783/badge\n :target: https://www.bestpractices.dev/projects/7783\n\n.. |MNE| image:: https://mne.tools/dev/_static/mne_logo_gray.svg\n :target: https://mne.tools/dev/\n",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": "MNE-Python project for MEG and EEG data analysis.",
"version": "1.8.0",
"project_urls": {
"Bug Tracker": "https://github.com/mne-tools/mne-python/issues/",
"Documentation": "https://mne.tools/",
"Download": "https://pypi.org/project/mne/#files",
"Forum": "https://mne.discourse.group/",
"Homepage": "https://mne.tools/",
"Source Code": "https://github.com/mne-tools/mne-python/"
},
"split_keywords": [
"ecog",
" eeg",
" meg",
" brain",
" fnirs",
" neuroimaging",
" neuroscience"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c835f6b8325e97917578122c9e8326aca751118f465540b7ddefc13e99ea932b",
"md5": "14538682a127ba79f8fb91fa687a484e",
"sha256": "8398695e2bf754a33cafe10668edb515297dc32014dec94e646491095fa959ab"
},
"downloads": -1,
"filename": "mne-1.8.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "14538682a127ba79f8fb91fa687a484e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 7381824,
"upload_time": "2024-08-19T02:18:45",
"upload_time_iso_8601": "2024-08-19T02:18:45.822005Z",
"url": "https://files.pythonhosted.org/packages/c8/35/f6b8325e97917578122c9e8326aca751118f465540b7ddefc13e99ea932b/mne-1.8.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "49957f452591f863ca9d5a98b171ca6d2b3c357e94ca02e02a87149776a7db8e",
"md5": "eab1ef6578e0fb6a3fd2c0119279fb83",
"sha256": "5247d92ebbc8e9871edca50d8071c024727249cb72ca1aba5fad1ee8ffa78312"
},
"downloads": -1,
"filename": "mne-1.8.0.tar.gz",
"has_sig": false,
"md5_digest": "eab1ef6578e0fb6a3fd2c0119279fb83",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 7093638,
"upload_time": "2024-08-19T02:18:49",
"upload_time_iso_8601": "2024-08-19T02:18:49.200057Z",
"url": "https://files.pythonhosted.org/packages/49/95/7f452591f863ca9d5a98b171ca6d2b3c357e94ca02e02a87149776a7db8e/mne-1.8.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-19 02:18:49",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "mne-tools",
"github_project": "mne-python",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"circle": true,
"lcname": "mne"
}
JSON
