dmolony3 / SlicerFractionalMyocardialMass

Repository for calculating the fractional myocardial mass and the myocardial mass at risk
MIT License
0 stars 1 forks source link

Register a sample dataset #4

Closed jcfr closed 1 month ago

jcfr commented 1 year ago

To help prospective user understand how to use the extension, a sampledata set should be registered and offered for download to the user.

For example, see https://github.com/Slicer/Slicer/blob/5.2/Utilities/Templates/Modules/Scripted/TemplateKey.py#L45-L89

dmolony3 commented 1 year ago

Thanks @jcfr. I can provide sample data but I'm a little unclear on the process. Should the url link to data held on my github or is there a preferred alternative location for Slicer?

jcfr commented 1 year ago

Should the url link to data held on my github or is there a preferred alternative location for Slicer?

Anticipating that your project will likely grow, I suggest to create a release called SampleData. This will avoid directly adding binary files to the commit history.

To create the SampleData release, consider using https://gist.github.com/jcfr/9c0c0133c2d3fa2b029e6dd2648f7720 where you would set the variables like this:

tag_name=sampledata
release_name=SampleData

org=dmolony3
proj=SlicerFractionalMyocardialMass

Notes:

Examples:

dmolony3 commented 1 month ago

Thanks, I have added sampledata and a test using the sample data.