.. -*- 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
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:
.. ↓↓↓ BEGIN CORE DEPS LIST. DO NOT EDIT! HANDLED BY PRE-COMMIT HOOK ↓↓↓
- `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>`__ ≥ 0.3
- `packaging <https://packaging.pypa.io/en/stable/>`__
.. ↑↑↑ END CORE DEPS LIST. DO NOT EDIT! HANDLED BY PRE-COMMIT HOOK ↑↑↑
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.10",
"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/e0/4d/c5d8e349062a6dc73872dc5e41b5d935590a8863149f13036bb85045b1f2/mne-1.9.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\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.. \u2193\u2193\u2193 BEGIN CORE DEPS LIST. DO NOT EDIT! HANDLED BY PRE-COMMIT HOOK \u2193\u2193\u2193\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>`__ \u2265 0.3\n- `packaging <https://packaging.pypa.io/en/stable/>`__\n\n.. \u2191\u2191\u2191 END CORE DEPS LIST. DO NOT EDIT! HANDLED BY PRE-COMMIT HOOK \u2191\u2191\u2191\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.9.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": "808ee3e7de62143236712c359db50c6bd6486557b1c5efb7d45682b8efc0a6a6",
"md5": "1525c46da22da94ad9806dfd966481d1",
"sha256": "c26da9ac59bce963c5b25a3be9f5f61dd128f980cdc178a6fceef27743734306"
},
"downloads": -1,
"filename": "mne-1.9.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1525c46da22da94ad9806dfd966481d1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 7392868,
"upload_time": "2024-12-18T21:23:23",
"upload_time_iso_8601": "2024-12-18T21:23:23.642922Z",
"url": "https://files.pythonhosted.org/packages/80/8e/e3e7de62143236712c359db50c6bd6486557b1c5efb7d45682b8efc0a6a6/mne-1.9.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e04dc5d8e349062a6dc73872dc5e41b5d935590a8863149f13036bb85045b1f2",
"md5": "bcb72b4864095c3d9270ef477240389b",
"sha256": "101967698b005a7f9071586e0469aebc83fe06f48717a95f3382a6f99c591162"
},
"downloads": -1,
"filename": "mne-1.9.0.tar.gz",
"has_sig": false,
"md5_digest": "bcb72b4864095c3d9270ef477240389b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 7104534,
"upload_time": "2024-12-18T21:23:27",
"upload_time_iso_8601": "2024-12-18T21:23:27.963144Z",
"url": "https://files.pythonhosted.org/packages/e0/4d/c5d8e349062a6dc73872dc5e41b5d935590a8863149f13036bb85045b1f2/mne-1.9.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-18 21:23:27",
"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
