Skip to content

Commit

Permalink
Merge pull request #13 from brainhackorg/publish-project
Browse files Browse the repository at this point in the history
[ENH] Convert issues to project pages
  • Loading branch information
crnolan authored Nov 1, 2024
2 parents 8ad2f5f + 5bf890c commit f189096
Showing 1 changed file with 210 additions and 0 deletions.
210 changes: 210 additions & 0 deletions content/project/project_8.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,210 @@
{
"Title": "Neurodesk: build interactive examples to learn about neuroimaging analysis",
"link_to_issue": "https://github.com/brainhackorg/global2024/issues/8",
"issue_number": 8,
"labels": [
{
"name": "git_skills:0_none",
"description": "",
"color": "5B6C2C"
},
{
"name": "git_skills:1_commit_push",
"description": "",
"color": "5B6C2C"
},
{
"name": "hub:melbourne_aus",
"description": "",
"color": "0E8A16"
},
{
"name": "modality:fMRI",
"description": "",
"color": "1d76db"
},
{
"name": "modality:MRI",
"description": "",
"color": "1d76db"
},
{
"name": "programming:documentation",
"description": "",
"color": "5319E7"
},
{
"name": "programming:Python",
"description": "",
"color": "5319E7"
},
{
"name": "programming:shell_scripting",
"description": null,
"color": "ededed"
},
{
"name": "programming:Unix_command_line",
"description": "",
"color": "5319E7"
},
{
"name": "project",
"description": "",
"color": "B60205"
},
{
"name": "project_development_status:2_releases_existing",
"description": "",
"color": "D93F0B"
},
{
"name": "project_type:data_management",
"description": null,
"color": "ededed"
},
{
"name": "project_type:documentation",
"description": null,
"color": "ededed"
},
{
"name": "project_type:pipeline_development",
"description": null,
"color": "ededed"
},
{
"name": "project_type:visualisation",
"description": null,
"color": "ededed"
},
{
"name": "status:web_ready",
"description": "",
"color": "0E8A16"
},
{
"name": "tools:AFNI",
"description": "",
"color": "EA1D4E"
},
{
"name": "tools:ANTs",
"description": "",
"color": "EA1D4E"
},
{
"name": "tools:BIDS",
"description": "",
"color": "EA1D4E"
},
{
"name": "tools:Brainstorm",
"description": "",
"color": "EA1D4E"
},
{
"name": "tools:Datalad",
"description": "",
"color": "EA1D4E"
},
{
"name": "tools:FieldTrip",
"description": "",
"color": "EA1D4E"
},
{
"name": "tools:fMRIPrep",
"description": "",
"color": "EA1D4E"
},
{
"name": "tools:Freesurfer",
"description": "",
"color": "EA1D4E"
},
{
"name": "tools:FSL",
"description": "",
"color": "EA1D4E"
},
{
"name": "tools:Jupyter",
"description": "",
"color": "EA1D4E"
},
{
"name": "tools:MNE",
"description": "",
"color": "EA1D4E"
},
{
"name": "tools:MRtrix",
"description": "",
"color": "EA1D4E"
},
{
"name": "tools:Nipype",
"description": "",
"color": "EA1D4E"
},
{
"name": "tools:SPM",
"description": "",
"color": "EA1D4E"
},
{
"name": "topic:connectome",
"description": "",
"color": "FBCA04"
},
{
"name": "topic:data_visualisation",
"description": "",
"color": "FBCA04"
},
{
"name": "topic:MR_methodologies",
"description": "",
"color": "FBCA04"
},
{
"name": "topic:physiology",
"description": "",
"color": "FBCA04"
},
{
"name": "topic:reproducible_scientific_methods",
"description": "",
"color": "FBCA04"
},
{
"name": "topic:statistical_modelling",
"description": "",
"color": "FBCA04"
},
{
"name": "topic:systems_neuroscience",
"description": "",
"color": "FBCA04"
},
{
"name": "project_type:tutorial_recording",
"description": null,
"color": "ededed"
},
{
"name": "tools:CPAC",
"description": null,
"color": "ededed"
},
{
"name": "topic:tractography",
"description": null,
"color": "ededed"
}
],
"content": "### Title\r\n\r\nNeurodesk: build interactive examples to learn about neuroimaging analysis\r\n\r\n### Leaders\r\n\r\nThuy Dao (Mattermost @thuy)\r\n\r\n### Collaborators\r\n\r\nSteffen Bollmann (Mattermost @sbollmann_mri), Andrew Jahn, Monika Doerig\r\n\r\n### Brainhack Global 2024 Event\r\n\r\nBrainhack Aus\r\n\r\n### Project Description\r\n\r\nThis project aims to build, test, and maintain interactive neuroimaging analysis examples using Jupyter notebooks, GitHub Actions, and Neurodesk. Although resources like Andy\u2019s Brainbook provide excellent learning material, they lack interactivity and can quickly become outdated as software functionalities and parameters evolve, often breaking tutorials.\r\n\r\nBy leveraging Neurodesk\u2019s containerized environment, we can create reliable, reproducible examples that allow users to explore parameters interactively and build a foundation for their own analyses. These notebooks will also serve as open materials for workshops, facilitating hands-on learning and collaborative projects. Additionally, automating testing with GitHub Actions will ensure examples remain functional and up-to-date.\r\n\r\nThis project also has potential for community growth: extending the notebook collection through contributions from global Brainhack events would enrich the resource pool with diverse analysis techniques, supporting a broad range of neuroimaging needs.\r\n\r\n### Link to project repository/sources\r\n\r\nhttps://github.com/NeuroDesk/example-notebooks\r\n\r\n### Goals for Brainhack Global\r\n\r\n- Build examples from [Andy's brainbook](https://andysbrainbook.readthedocs.io/en/latest/)\r\n\r\n### Good first issues\r\n\r\n1. [AFNI_01_DataDownload](https://andysbrainbook.readthedocs.io/en/latest/AFNI/AFNI_Short_Course/AFNI_01_DataDownload.html)\r\n\r\n2. [AFNI_04_Preprocessing](https://andysbrainbook.readthedocs.io/en/latest/AFNI/AFNI_Short_Course/AFNI_04_Preprocessing.html)\r\n\r\n\r\n### Communication channels\r\n\r\n[Mattermost](https://mattermost.brainhack.org/brainhack/channels/virtual-neuro-machine-vnm)\r\n[Github Discussion](https://github.com/orgs/NeuroDesk/discussions)\r\n\r\n### Skills\r\n\r\n- Knowledge of analysis procedures. \r\n- Bash\r\n- Python\r\n\r\n### Onboarding documentation\r\n[README](https://github.com/NeuroDesk/example-notebooks/blob/main/README.md)\r\n[Existing examples](https://www.neurodesk.org/example-notebooks/intro.html#)\r\n\r\n### What will participants learn?\r\n\r\n- Neurodesk\r\n- Github\r\n- The toolkit they want to document, learn, or share their own pipeline\r\n\r\n### Data to use\r\n\r\nOpenNeuro or other openly available dataset\r\n\r\n### Number of collaborators\r\n\r\n2\r\n\r\n### Credit to collaborators\r\n\r\nProject contributors will be listed in their notebooks and Neurodesk documentation and offered co-authorship in the global OHBM 2025 abstract describing this work.\r\n\r\n### Image\r\n\r\nLeave this text if you don't have an image yet.\r\n\r\n### Type\r\n\r\ndata_management, pipeline_development, tutorial_recording\r\n\r\n### Development status\r\n\r\n2_releases_existing\r\n\r\n### Topic\r\n\r\nconnectome, data_visualisation, MR_methodologies, physiology, reproducible_scientific_methods, statistical_modelling, systems_neuroscience, tractography\r\n\r\n### Tools\r\n\r\nAFNI, ANTs, BIDS, Brainstorm, CPAC, Datalad, FieldTrip, fMRIPrep, Freesurfer, FSL, Jupyter, MNE, MRtrix, Nipype, SPM\r\n\r\n### Programming language\r\n\r\nPython, shell_scripting, unix_command_line\r\n\r\n### Modalities\r\n\r\nfMRI, MRI\r\n\r\n### Git skills\r\n\r\n0_no_git_skills, 1_commit_push\r\n\r\n### Anything else?\r\n\r\n_No response_\r\n\r\n### Things to do after the project is submitted and ready to review.\r\n\r\n- [x] Add a comment below the main post of your issue saying: `Hi @brainhackorg/project-monitors my project is ready!`\r\n- [x] Twitter-sized summary of your project pitch.",
"project_url": "https://github.com/NeuroDesk/example-notebooks",
"project_description": "\r\n\r\nThis project aims to build, test, and maintain interactive neuroimaging analysis examples using Jupyter notebooks, GitHub Actions, and Neurodesk. Although resources like Andy\u2019s Brainbook provide excellent learning material, they lack interactivity and can quickly become outdated as software functionalities and parameters evolve, often breaking tutorials.\r\n\r\nBy leveraging Neurodesk\u2019s containerized environment, we can create reliable, reproducible examples that allow users to explore parameters interactively and build a foundation for their own analyses. These notebooks will also serve as open materials for workshops, facilitating hands-on learning and collaborative projects. Additionally, automating testing with GitHub Actions will ensure examples remain functional and up-to-date.\r\n\r\nThis project also has potential for community growth: extending the notebook collection through contributions from global Brainhack events would enrich the resource pool with diverse analysis techniques, supporting a broad range of neuroimaging needs.\r\n\r\n"
}

0 comments on commit f189096

Please sign in to comment.