Sharing data on MRSHub
There are two easy ways to submit data to be featured on MRSHub (more details below:)
Create an MRSHub forum post with
[DATA SUBMISSION] ...in the title, and include the submission information outlined below.
E-mail (remove the dashes) us directly.
We will then generate an MRSHub website entry.
What kind of data can I submit?
We distinguish between two types of dataset submission:
- Example datasets: Smaller datasets that can be hosted in a single GitHub repository, and have a total size of less than 200 MB. We can fork these data into the MRSHub GitHub account.
- Large datasets: Larger-scale datasets exceeding a total size of 200 MB. These datasets need to be hosted on an external file hoster (please click here for further instructions). Once you submit a large dataset, we will add an entry to the MRSHub dataset collection
What do I have to include in my submission?
There are two short text files required, and one optional file you can provide.
(required) In both submission methods, you have to provide a
SUBMISSION.mdtext file. This contains the information that shows up in your MRSHub website entry.
(required) You should provide a
LICENSE.mdtext file with your licensing requirements. If not provided, we will automatically include a BSD 3-clause license (approved by the Open Source Initiative) to the dataset.
- Templates for various licenses (BSD, MIT, GPL) can be found here.
(optional) You may provide a small, square logo file (
.JPGformat) that will help personalize your MRSHub website entry.
What goes into the
We provide a template
SUBMISSION.md file for your convenience here.
|Developer||Yes||The name(s) you want to credit with development|
|Name of dataset||Yes||The name of the dataset.|
|Abstract||Yes||A brief description of the dataset you contribute.|
|Type||Yes||The type of data. We recommend to pick one of these:
|Format||Yes||The file formats used to store your dataset.|
|Sequence||Yes||The MRS sequence(s) used to acquire the dataset.|
|Credit||No||Indicate how you would like to be credited for your data - for example, if a certain publication should be cited, or whether you would like to be acknowledged in publications using your data.|
|Contact||No||A way you can be contacted, for example an e-mail address, the website of your lab, or your LinkedIn/Researchgate/Google Scholar page. Please note, this information will be made available on MRSHub website, so if you would rather your e-mail not be made public, please don’t include.|
|Publication||No||A publication you want to associate with the submission|
|URL||Yes/No||A URL to a project page, data repository etc. associated with the submission. If you are submitting data hosted in an external repository, this field is mandatory.|
Very specific details about how to submit
Submitting through MRSHub forum
Create a new topic in the MRSHub forum with the basic submission information. We will then create an entry for your submission to the MRSHub dataset collection. If you submit an example dataset (<200 MB total file size), we will also create a repository in the MRSHub GitHub account.
Submitting directly via GitHub (EXAMPLE DATASETS ONLY)
Create a new topic in the MRSHub forum with a link to your example data repository. We will fork the repository into the MRSHub GitHub account.
Submitting through e-mail
Send an e-mail (remove the dashes) with the basic submission information. We will then create an entry for your submission to the MRSHub dataset collection. If you submit an example dataset (<200 MB total file size), we will also create a repository in the MRSHub GitHub account.