MRSHub User Guide
Welcome to the MRSHub! We’re glad you found your way into our community.
This post wants to provide a quick orientation of the resources that the MRSHub provides. We would also like to encourage you to become a regular visitor and contributor. If you have suggestions or feedback, please don’t hesitate to let us know.
What is MRSHub?
The MRSHub is a place for magnetic resonance spectroscopy researchers. With your help, we want to gather useful code and datasets, foster a spirit of community and collaboration, and join forces to unleash the full potential of MRS.
The three main pillars of the MRSHub are
- a curated list of useful software packages and open-source code
- a list of freely available MRS datasets for download
- a forum for collaboration, exchange, and support
Why should we share code and data at all?
The MRSHub was born out of the realization that a lot of the efforts in our community are duplicate. We all spend so much time and resources re-creating the same methods and code that someone else has already created. We all spend weeks writing simulation and data processing scripts that someone else has sitting on their hard drive already. And all of these duplicate efforts can’t go in the paper!
We all want to do the science first. If we can re-use code (and data) from somewhere else, the community can focus on the science, and developers can get credit for their work.
Contributing useful code that you wrote to solve a recurring task, or sharing datasets you acquired and/or simulated is a great way to…
- avoid duplication of efforts.
- develop and improve data processing routines.
- benchmark quantification algorithms.
- assist the community in creating tools and propel transparent science.
- have your findings scrutinized and reproduced.
- get credit and gain recognition of your work.
Let’s make sure that no one has to re-invent a wheel ever again!
I’m a student/postdoc/junior researcher! How can I help?
Awesome! We hope you will come back frequently in the future!
We are especially pleased to have you on board if you are new to the field of MRS, or simply interested in creating something that is useful for others. If you haven’t already: please say hi and tell us a little bit about yourself in the Introduce Yourself! category!
There are many ways you can contribute to the MRSHub community:
- Contribute data processing, analysis, or visualization code
- Basis set library generation
- Help develop standardized file formats (BIDS, ISMRMD)
- High-quality datasets
- Artefact real-life datasets
- Simulated datasets
- Membership in the Committee for MRS Code & Data Sharing
- Administration of the MRSHub website and GitHub repository
- Moderation of the MRSHub forum
- Write blog posts
- Write data analysis tutorials
If you don’t know how to get started on any of these, please include your favourite area of contribution in your introduction post - we’ll make sure we’ll find something useful for you!
I’m a PI/supervisor/senior researcher! How can I help?
We’re very grateful that you want to support the MRSHub cause! We know that time and resources are limited. Making code and/or data available to others constitutes extra work that you could spend on writing new grants and papers. Here are multiple ways you can help:
- Allow, encourage, and support your trainees to volunteer some time to contribute code, data, or expertise
- Adopt and foster open-source code and data sharing practices
- Share analysis software and datasets you have created and acquired over the years
- Advocate for these practices on your institutional and editorial boards
- Answer questions from junior researchers in this forum
- Volunteer time - become a member in the Membership in the Committee for MRS Code & Data Sharing