Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOC: Add resources for Python, terminal use etc. #11370

Open
britta-wstnr opened this issue Dec 15, 2022 · 4 comments
Open

DOC: Add resources for Python, terminal use etc. #11370

britta-wstnr opened this issue Dec 15, 2022 · 4 comments
Labels
Milestone

Comments

@britta-wstnr
Copy link
Member

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.

@drammock
Copy link
Member

We have this page https://mne.tools/stable/overview/learn_python.html

What I'm hearing is that it's not discoverable.

@britta-wstnr
Copy link
Member Author

Oh!
Well, I searched for it and did not find it. Based on the questions I get asked, it seems like it is the same for users - and it seems @larsoner was not aware either ...

Maybe we could move it to tutorials? This is where most people seem to land if they feel like they need an in-depth start.

@larsoner
Copy link
Member

A few potential ideas

  1. Move from overview to tutorials
  2. Add a new tutorial intro/05_new_to_python.py that just links to the overview doc
  3. Add to existing intro/10_overview.py a .. sidebar:: or so that links to the overview doc

@drammock
Copy link
Member

IMO the docs need a medium-sized overhaul, cf #10707. I think this issue and that one should be addressed together, as I don't think we can find the "right place" for this info in the current (IMO wrong) organization of the (non-tutorial) docs content.

@larsoner larsoner added this to the 1.4 milestone Dec 15, 2022
@larsoner larsoner modified the milestones: 1.4, 1.5 Apr 28, 2023
@larsoner larsoner modified the milestones: 1.5, 1.6 Jul 31, 2023
@larsoner larsoner modified the milestones: 1.6, 1.7 Nov 16, 2023
@larsoner larsoner modified the milestones: 1.7, 1.8 Apr 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants