Skip to content

update installation recommendations#9634

Merged
drammock merged 19 commits intomne-tools:mainfrom
drammock:install-docs
Aug 5, 2021
Merged

update installation recommendations#9634
drammock merged 19 commits intomne-tools:mainfrom
drammock:install-docs

Conversation

@drammock
Copy link
Copy Markdown
Member

@drammock drammock commented Aug 1, 2021

closes #9623

  • add instructions about updating envs
  • add "pro tips" like using mamba, using different envs for each project, keeping a list of other packages you install (to make it easier to recreate envs), etc.

@drammock drammock marked this pull request as ready for review August 2, 2021 23:59
@drammock drammock requested a review from rob-luke August 3, 2021 00:00
@rob-luke
Copy link
Copy Markdown
Member

rob-luke commented Aug 3, 2021

@drammock I have a few colleagues who are interested in getting started with MNE but havent installed it yet. They are scientists but not tech focused. If you wish, I could get them to follow the install instructions and give us user feedback, but it would happen sometime in the next week (not in the next day or two).

@drammock
Copy link
Copy Markdown
Member Author

drammock commented Aug 3, 2021

If you wish, I could get them to follow the install instructions and give us user feedback, but it would happen sometime in the next week (not in the next day or two).

Great! Let's get this merged in and backported after I address your other comment (tomorrow, it's late here). Then your colleagues' feedback can be addressed in a second PR

@drammock
Copy link
Copy Markdown
Member Author

drammock commented Aug 3, 2021

@rob-luke @cbrnr @hoechenberger this one is ready for final review/merge.

@rob-luke
Copy link
Copy Markdown
Member

rob-luke commented Aug 4, 2021

PR is awesome

Then your colleagues' feedback can be addressed in a second PR

Will do, ill try not to interfere while I watch them :)

Copy link
Copy Markdown
Contributor

@cbrnr cbrnr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very nice summary @drammock! Apart from my minor comments this is ready to merge IMO. On a somewhat unrelated note, it is sad how complicated package installation has become in Python (or rather, it has always been like that) 😢 . Don't ever try Julia because that's how package management should be in Python 😉 .

@hoechenberger
Copy link
Copy Markdown
Member

Don't ever try Julia because that's how package management should be in Python 😉 .

or npm. Python packaging is really the worst, it was maybe okay-ish 10 years ago but these days, it's almost unacceptably bad.

drammock and others added 3 commits August 4, 2021 08:50
Co-authored-by: Richard Höchenberger <richard.hoechenberger@gmail.com>
Co-authored-by: Robert Luke <748691+rob-luke@users.noreply.github.com>
Co-authored-by: Clemens Brunner <clemens.brunner@gmail.com>
Copy link
Copy Markdown
Member

@hoechenberger hoechenberger left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Otherwise LGTM!

drammock and others added 2 commits August 5, 2021 10:30
Co-authored-by: Richard Höchenberger <richard.hoechenberger@gmail.com>
@drammock drammock added the backport-candidate on-merge: backport to maint/1.12 label Aug 5, 2021
@drammock drammock merged commit 8f62deb into mne-tools:main Aug 5, 2021
@cbrnr
Copy link
Copy Markdown
Contributor

cbrnr commented Aug 5, 2021

Thanks @drammock !

drammock added a commit that referenced this pull request Aug 5, 2021
* use a variable for min python version

* recommend conda-forge to install mne

* recommend conda-forge-based installation

* fix include path

* clarify quickstart

* use replace vars in install instructions

* clarify install instructions

* add page with guidance for upgrading

* split out python from MNE install page

* deduplicate

* simpler

* fix command

* tweaks

* add miniforge

* Apply suggestions from code review

Co-authored-by: Richard Höchenberger <richard.hoechenberger@gmail.com>
Co-authored-by: Robert Luke <748691+rob-luke@users.noreply.github.com>
Co-authored-by: Clemens Brunner <clemens.brunner@gmail.com>

* more changes from code review

* better windows formatting

* fix macos paths

* more equals signs

Co-authored-by: Richard Höchenberger <richard.hoechenberger@gmail.com>

Co-authored-by: Richard Höchenberger <richard.hoechenberger@gmail.com>
Co-authored-by: Robert Luke <748691+rob-luke@users.noreply.github.com>
Co-authored-by: Clemens Brunner <clemens.brunner@gmail.com>
@drammock drammock added backported and removed backport-candidate on-merge: backport to maint/1.12 labels Aug 5, 2021
@drammock
Copy link
Copy Markdown
Member Author

drammock commented Aug 5, 2021

backported

@drammock drammock deleted the install-docs branch August 5, 2021 19:18
@agramfort
Copy link
Copy Markdown
Member

Thx @drammock

regarding comments on packaging. Npm is easier as it’s only JavaScript not python, c++, OpenGL / vtk etc. Regarding Julia yes maybe but I want to see something flying with the complexity of mne dependencies. You want to help packaging -> reduce dependencies and keep complexity low ! Packaging across platforms is just damned hard !

@cbrnr
Copy link
Copy Markdown
Contributor

cbrnr commented Aug 5, 2021

reduce dependencies and keep complexity low

Yes, that's true no matter what programming language.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

RFC: installation process instructions

5 participants