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

Somehow document which packages and tools are part of the installers #104

Open
hoechenberger opened this issue Mar 20, 2022 · 3 comments
Open
Labels
documentation Improvements or additions to documentation enhancement New feature or request packages

Comments

@hoechenberger
Copy link
Member

hoechenberger commented Mar 20, 2022

I doubt most users will be aware of the fact that we bundle FSLeyes, the GitHub CLI, and other super helpful tools if we don't tell them we do.

We removed this list from the MNE docs out of fear it would be outdated very quickly.

Since all installed "extra" conda packages are listed in construct.yaml, it should be relatively easy to generate a nicely-formatted list of bundled packages every time we build the installers. I think it could be as simple as a markdown table (left column: package name; right column: short description of what it does)

This list could live in this repository, and the official MNE docs would just link to it.

WDYT, @agramfort @larsoner?

@hoechenberger hoechenberger added documentation Improvements or additions to documentation enhancement New feature or request packages labels Mar 20, 2022
@agramfort
Copy link
Member

agramfort commented Mar 20, 2022 via email

@hoechenberger
Copy link
Member Author

hoechenberger commented Mar 20, 2022

But even so, there's many more packages and tools that we bundle :) like dcm2nixx
In the future, we could even include git if we wanted to …

@larsoner
Copy link
Member

larsoner commented Sep 1, 2023

Cross-ref mne-tools/mne-python#11831 which is related

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request packages
Projects
None yet
Development

No branches or pull requests

3 participants