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

Deepprep descriptor #297

Merged
merged 3 commits into from
Feb 20, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
117 changes: 117 additions & 0 deletions boutiques_descriptors/deepprep_24_1_2.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,117 @@
{
"name": "DeepPrep",
Copy link
Contributor

Choose a reason for hiding this comment

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

@prioux not sure, do we have some convention to add a suffix SingleSubjects or BidsSubject to tool name or that practice is deprecated?

"tool-version": "24.1.2",
"schema-version": "0.5",
"author": "personalized Brain Functional Sectors (pBFS) Lab",
"description": "An accelerated, scalable, and robust pipeline for neuroimaging preprocessing empowered by deep learning",
"descriptor-url": "https://deepprep.readthedocs.io/en/24.1.2/",
Copy link
Contributor

Choose a reason for hiding this comment

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

BTW
I think it is wrong url, descriptor-url is the url of the boutiques descriptor not tool

"command-line": "wd=\"$PWD\"; /opt/DeepPrep/deepprep/deepprep.sh \"$wd\"/<bids_dir> \"$wd\"/<output_dir> participant --fs_license_file \"$wd\"/<fs_license_file> <bold_task_type> --skip_bids_validation",
"inputs": [
{
"description": "BIDS dataset input directory",
"id": "bids_dir",
"name": "bids_dir",
"optional": false,
"type": "File",
"value-key": "<bids_dir>"
},
{
"description": "The output directory",
"id": "output_dir_name",
"name": "output_dir_name",
"optional": false,
"type": "String",
"value-key": "<output_dir>"
},
{
"command-line-flag": "--bold_task_type",
"description": "The task label of BOLD images",
"id": "bold_task_type",
"name": "bold_task_type",
"optional": false,
"type": "String",
"value-key": "<bold_task_type>",
"value-choices": [
"6cat",
"rest",
"motor",
"rest motor"
]
},
{
"description": "FreeSurfer license file",
"id": "fs_license_file",
"name": "fs_license_file",
"optional": false,
"type": "File",
"value-key": "<fs_license_file>"
}
],
"groups": [
{
"id": "mandatory",
"name": "Mandatory parameters",
"description": "Mandatory parameters",
"members": [
"bids_dir",
"output_dir_name",
"bold_task_type"
]
}
],
"output-files": [
{
"id" : "output_dir",
"name" : "Output Directory",
"description" : "This is the directory where the overall outputs are to be stored.",
"path-template" : "<output_dir>",
"optional" : false
}
],
"suggested-resources": {
"cpu-cores": 4,
"ram": 12,
"walltime-estimate": 172000
},
"tags": {
Copy link
Contributor

Choose a reason for hiding this comment

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

Is it an alternative to frmiPrep? I'd copy all tags from there

"application-type": [
"bids"
],
"domain": [
"neuroinformatics",
"deeplearning"
]
},
"container-image": {
"type": "singularity",
"index": "docker://",
"image": "pbfslab/deepprep:24.1.2"
},
"custom": {
"cbrain:author": "Natacha Beck <[email protected]>",
"cbrain:readonly-input-files": true,
"cbrain:integrator_modules": {
"BoutiquesFileTypeVerifier": {
"bids_dir": [ "BidsSubject" ],
"fs_license_file": [ "FreesurferLicense", "TextFile", "SingleFile" ]
},
"BoutiquesFileNameMatcher": {
"bids_dir": "^sub-[a-zA-Z0-9_]+$"
},
"BoutiquesFreesurferLicenseFinder": "fs_license_file",
"BoutiquesOutputFileTypeSetter": {
"output_dir": "FileCollection"
},
"BoutiquesPostProcessingCleaner": [
"<output_dir>"
],
"BoutiquesBidsSingleSubjectMaker": "bids_dir",
"BoutiquesInputCacheCleaner": [ "bids_dir" ],
"BoutiquesOutputCacheCleaner": [ "output_dir" ],
"BoutiquesOutputFilenameRenamer": {
"output_dir": [ "bids_dir", "output_dir_name" ]
}
}
}
}