mne-tools / mne-tools/mne-python

DOC: Add resources for Python, terminal use etc.

Open
#11,370 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

DOC
Dominant language
Python
Stars
3.5k
Forks
1.6k
Avg merge
1d 6h
Merged PRs (30d)
100

Description

Proposed documentation enhancement

We have tutorials on how to get started with MNE-Python that cover some more general aspects of Python (e.g. https://mne.tools/stable/auto_tutorials/intro/15_inplace.html).
I often get asked where to start if you do not know any Python at all yet - and as far as I am aware there is no material on the MNE homepage for that.
Maybe we could add a tutorial page with resources we can recommend for getting started with Python, numpy, or also the use of a terminal.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the existing getting-started material, including the intro tutorial at auto_tutorials/intro/15_inplace.html, and identify where a beginner-resources page would fit. Gather appropriate resources for Python, NumPy, and terminal use; done means the recommendations are published on the MNE-Python documentation site.

Written by the indexing model from the issue text.

Assessment

Tech stack
numpy, python
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.