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

Brainhack project #41

Merged
merged 15 commits into from
Jun 11, 2024
112 changes: 112 additions & 0 deletions publications/ohbm_2024/brainhack_project.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,112 @@
To be submitted [here](https://github.com/ohbm/hackathon2024/issues/new?assignees=sina-mansour&labels=Hackathon+Project&projects=&template=brainhack-hacktrack-project.yml&title=%3CMy+Project+Name%3E)

Combined from previous years:
- 2023: https://github.com/ohbm/hackathon2023/issues/15
- 2022: https://github.com/ohbm/hackathon2022/issues/48

# Title
(Name of your awesome project. Please also update the title of the issue to be the title of your project)
```txt
Nilearn: Statistics and Machine Learning for Neuroimaging in Python
```
Comment on lines +9 to +11
Copy link
Contributor Author

Choose a reason for hiding this comment

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

In case it was unclear earlier: The answers are inside the these '''txt ... ''' blocks.


# Short description and the goals for the OHBM BrainHack
(Please provide a short description and goals for the hackathon, check [the guide](https://github.com/ohbm/hackathon2024/blob/main/.github/ISSUE_TEMPLATE/handbooks/projects.md#goals) for suggestions)
```txt
Nilearn is an open-source Python package for fast and easy analysis and visualization of MRI brain images. It provides statistical and machine-learning tools, with instructive documentation and a friendly community. It includes applications such as multi-voxel pattern analysis (MVPA), decoding, predictive modelling, functional connectivity, and brain parcellations.

Recent work in Nilearn has been centered on developing a new API to allow users to seamlessly work with surface data in a manner similar to volumetric data, enhancing support for the General Linear Model (GLM), enhancing the BIDS interface, and improving and updating the infrastructure and codebase.

We want to dedicate these Brainhack days towards direct interaction with our user-base and resolving any specific issues they might have. To this end, we encourage users to simply pop-in-and-say-hi. They are also welcome to present their queries via neurostars.org or open new issues/PRs on our GitHub repo. In addition, any interested contributors are also encouraged to work on pre-existing issues on our GitHub. New contributors should look for the "Good First Issue" label to get started.
```

# Link to the project
(Please provide **one URL** for the project, e.g. GitHub repository. See [the guide](https://github.com/ohbm/hackathon2024/blob/main/.github/ISSUE_TEMPLATE/handbooks/projects.md#link-to-project) for other suggestions.)
```txt
https://github.com/nilearn/nilearn
```

# Image/Logo for the OHBM brainhack website
(Please provide a link only. Please provide the RAW content of the file if you use an image from a GitHub repo. We kindly request that the image be provided in a square format, ensuring equal width and height for a polished visual appearance.)
```txt
https://drive.google.com/file/d/1c2AcPvCCRWy80Se2m_lfVIlJc_1laon2/view?usp=sharing
```

# Project lead
(Your name and GitHub login AND Discord login (we will be using Discord during the hackathon, please be sure to register [here](https://discord.gg/yK8jakPfnG)). Add multiple leaders if you can, if leaders cover different hubs, please add this next to the name.)
```txt
Himanshu Aggarwal, Github: @man-shu, Discord: man_shooo
```

# Main Hub
(The main Hackathon Hub of your project, see more [here](https://github.com/ohbm/hackathon2024/blob/main/.github/ISSUE_TEMPLATE/handbooks/projects.md#hubs))
Options
- Seoul
- Hybrid (Asia / Pacific)
- Hybrid (Europe / Middle East / Africa)
- Hybrid (Americas)
```txt
Seoul
```

# Link to the Project pitch
(not required, but highly recommended) If your project involves hybrid/online participation, create a brief project pitch (2-5 minutes) for the Brainhack audience. See [more](https://github.com/ohbm/hackathon2024/blob/main/.github/ISSUE_TEMPLATE/handbooks/projects.md#pitch-video) for additional guidance. Upload the pitch video to YouTube and share the link with us.
```txt
```

# Other hubs covered by the leaders
(Please choose other hubs that are covered by your leaders (be sure to have at least one leader in the specific timezones, and make a note next to their names))
- Seoul
- Hybrid (Asia / Pacific)
- Hybrid (Europe / Middle East / Africa)
man-shu marked this conversation as resolved.
Show resolved Hide resolved
- Hybrid (Americas)
```txt
```

# Skills
(Please provide skills you expect contributors to have, so others can have better ideas if they can join. You can include non-technical skills, or simply write None, check [the guide](https://github.com/ohbm/hackathon2024/blob/main/.github/ISSUE_TEMPLATE/handbooks/projects.md#onboarding-skills) for more suggestions.)
```txt
We welcome all users and contributions from various skill sets and levels. This can include opening discussions around improvements to the [documentation](https://nilearn.github.io/stable/index.html) and/or [code base](https://github.com/nilearn/nilearn
), answering or commenting on questions or [issues raised on github](https://github.com/nilearn/nilearn/issues/4434) and [neurostars](https://neurostars.org/tag/nilearn), reviewing [pull requests](https://github.com/nilearn/nilearn/pulls), and [contributing code](https://nilearn.github.io/stable/development.html#how-to-contribute-to-nilearn).
```

# Recommended tutorials for new contributors
(Please provide a list of tutorials that might be helpful for new contributors. Make sure to include the link to the tutorials here. Several great examples of such tutorials can be found at the following places: [traintrack online selection](https://ohbm.github.io/hackathon2023/traintrack/), [brainhack school modules](https://school-brainhack.github.io/modules/), [Neurohackademy lectures](https://neurohackademy.org/course_type/lectures/), and [brainhack's youtube channel](https://www.youtube.com/c/brainhackorg/playlists))
```txt
We recommend starting with [Nilearn's basic tutorials](https://nilearn.github.io/stable/auto_examples/00_tutorials/index.html#) and the [introduction to Nilearn](https://nilearn.github.io/stable/introduction.html). This would help new contributors get familiar with the package and its functionalities. They can even provide feedback on the tutorials and suggest improvements.
```

# Good first issues
(If you welcome new contributors, please provide a list of good-first-issues (not required, but highly recommended), check [the guide](https://github.com/ohbm/hackathon2024/blob/main/.github/ISSUE_TEMPLATE/handbooks/projects.md#good-first-issues) for suggestions)
```txt
Here are a few issues:
- [Use nilearn's logger instead of print statement](https://github.com/nilearn/nilearn/issues/4443)
- [Add scripts to collect stats for the nilearn repo](https://github.com/nilearn/nilearn/issues/3791).
- [Update missing default value in docstrings](https://github.com/nilearn/nilearn/issues/3865)
- [Write tests for existing functions](https://github.com/nilearn/nilearn/issues/2750)
- [Add jupyterlite links to example gallery notebooks](https://github.com/nilearn/nilearn/issues/3951)

You can also find an updated list of issues for the Brainhack [here](https://github.com/nilearn/nilearn/issues?q=is:open+is:issue+label:Hackathon)

Depending upon your comfort level with the package, issues can also be filtered as follows:
- [Good first issues](https://github.com/nilearn/nilearn/labels/Good%20first%20issue)
- [Effort: Low](https://github.com/nilearn/nilearn/labels/Effort%3A%20low)
- [Effort: Medium](https://github.com/nilearn/nilearn/labels/Effort%3A%20medium)
- [Effort: High](https://github.com/nilearn/nilearn/labels/Effort%3A%20high)
man-shu marked this conversation as resolved.
Show resolved Hide resolved
```

# Twitter summary
(Twitter-size summary of your project pitch, please check [the guide](https://github.com/ohbm/hackathon2024/blob/master/.github/ISSUE_TEMPLATE/handbooks/projects.md#twitter-size-summary-of-your-project-pitch))
```txt
With @nilearn, we aim to simplify statistical analysis and machine learning on brain images in Python by fostering an open user-base and active contributing community.

Find us @OHBM @brainhackorg in Seoul, Korea, from June 20th to 22nd 2024.

https://nilearn.github.io/stable/index.html
```

# Short name for the Discord chat channel (~15 chars)
(Please give a short name for the Discord chat channel, e.g. "my-brain-project")
```txt
nilearn
```