{"_id":"586d3da9cd6e243900cfdd61","version":{"_id":"55faf11ba62ba1170021a9aa","project":"55faf11ba62ba1170021a9a7","__v":46,"createdAt":"2015-09-17T16:58:03.490Z","releaseDate":"2015-09-17T16:58:03.490Z","categories":["55faf11ca62ba1170021a9ab","55faf8f4d0e22017005b8272","55faf91aa62ba1170021a9b5","55faf929a8a7770d00c2c0bd","55faf932a8a7770d00c2c0bf","55faf94b17b9d00d00969f47","55faf958d0e22017005b8274","55faf95fa8a7770d00c2c0c0","55faf96917b9d00d00969f48","55faf970a8a7770d00c2c0c1","55faf98c825d5f19001fa3a6","55faf99aa62ba1170021a9b8","55faf99fa62ba1170021a9b9","55faf9aa17b9d00d00969f49","55faf9b6a8a7770d00c2c0c3","55faf9bda62ba1170021a9ba","5604570090ee490d00440551","5637e8b2fbe1c50d008cb078","5649bb624fa1460d00780add","5671974d1b6b730d008b4823","5671979d60c8e70d006c9760","568e8eef70ca1f0d0035808e","56d0a2081ecc471500f1795e","56d4a0adde40c70b00823ea3","56d96b03dd90610b00270849","56fbb83d8f21c817002af880","573c811bee2b3b2200422be1","576bc92afb62dd20001cda85","5771811e27a5c20e00030dcd","5785191af3a10c0e009b75b0","57bdf84d5d48411900cd8dc0","57ff5c5dc135231700aed806","5804caf792398f0f00e77521","58458b4fba4f1c0f009692bb","586d3c287c6b5b2300c05055","58ef66d88646742f009a0216","58f5d52d7891630f00fe4e77","59a555bccdbd85001bfb1442","5a2a81f688574d001e9934f5","5b080c8d7833b20003ddbb6f","5c222bed4bc358002f21459a","5c22412594a2a5005cc9e919","5c41ae1c33592700190a291e","5c8a525e2ba7b2003f9b153c","5cbf14d58c79c700ef2b502e","5db6f03a6e187c006f667fa4"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"githubsync":"","parentDoc":null,"project":"55faf11ba62ba1170021a9a7","__v":0,"user":"575e85ac41c8ba0e00259a44","category":{"_id":"586d3c287c6b5b2300c05055","version":"55faf11ba62ba1170021a9aa","__v":0,"project":"55faf11ba62ba1170021a9a7","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2017-01-04T18:17:12.683Z","from_sync":false,"order":22,"slug":"task-execution","title":"TASK EXECUTION"},"metadata":{"title":"","description":"","image":[]},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-01-04T18:23:37.290Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":12,"body":"[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Hint name\",\n    \"h-1\": \"Workflow level\",\n    \"h-2\": \"Node level\",\n    \"h-3\": \"Tool level\",\n    \"h-4\": \"Default\",\n    \"h-5\": \"Notes\",\n    \"h-6\": \"See also\",\n    \"0-0\": \"`sbg:CPURequirement`<sup>1</sup>\\nAllocates this many CPU cores for the execution of the tool.\",\n    \"1-2\": \":no-entry-sign:\",\n    \"0-3\": \":white-check-mark:\",\n    \"2-4\": \"Decided by the scheduling algorithm\",\n    \"2-5\": \":warning: The task will fail if the resources available on the instance are insufficient for any tool in the workflow.\",\n    \"0-2\": \":no-entry-sign:\",\n    \"0-1\": \":no-entry-sign:\",\n    \"0-4\": \"1\",\n    \"0-5\": \"Accepts dynamic expressions\",\n    \"0-6\": \"[Tool resource requirements](doc:about-tool-resource-requirements)\",\n    \"1-1\": \":no-entry-sign:\",\n    \"1-3\": \":white-check-mark:\",\n    \"2-1\": \":white-check-mark:\",\n    \"2-2\": \":white-check-mark:\",\n    \"2-3\": \":white-check-mark:\",\n    \"3-1\": \":white-check-mark:\",\n    \"4-3\": \":white-check-mark:\",\n    \"3-2\": \":no-entry-sign:\",\n    \"3-3\": \":no-entry-sign:\",\n    \"4-1\": \":no-entry-sign:\",\n    \"4-2\": \":no-entry-sign:\",\n    \"3-5\": \":warning:  If a step is an inner workflow, its `sbg:maxNumberOfParallelInstances` will be overridden with the value from the outer workflow, even if it has not been set explicitly (*i.e.* the default value takes precedence).\",\n    \"1-5\": \"Accepts dynamic expressions\",\n    \"1-4\": \"1024 [MB]\",\n    \"3-4\": \"1\",\n    \"4-4\": \"file name\",\n    \"1-0\": \"`sbg:MemRequirement`<sup>1</sup>\\nAllocates this much MB of RAM for the execution of the tool.\",\n    \"2-0\": \"`sbg:AWSInstanceType`\\nConfigures the type of all the AWS instances provisioned for this workflow/node/tool.\\nPriority: \\n*workflow > node > tool*\",\n    \"3-0\": \"`sbg:maxNumberOfParallelInstances`\\nSets the maximum number of instances that can run in parallel for workflow execution.\",\n    \"4-0\": \"`sbg:SaveLogs`\\nConfigures the additional files to preserve as logs inside the project\",\n    \"1-6\": \"[Tool resource requirements](doc:about-tool-resource-requirements)\",\n    \"2-6\": \"[Available AWS instances](doc:list-of-available-amazon-web-services-instances)\"\n  },\n  \"cols\": 7,\n  \"rows\": 5\n}\n[/block]\n<sup>1</sup> The hints prefixed with **sbg:** are specific for the Seven Bridges execution environment. CWL 1.0 introduces **coresMin** / **coresMax** (minimum and maximum number of CPU cores) and **ramMin** / **ramMax** (minimum and maximum amount of RAM) in [resource requirements](http://www.commonwl.org/v1.0/CommandLineTool.html#ResourceRequirement), which can be found on any level (**Workflow**, **Step**, **Tool**). If your CWL 1.0 app description contains only the **-Min** or the **-Max** value, the Seven Bridges execution environment will use the specified value as the number of cores or amount of RAM required for execution. If both the **-Min** and the **-Max** value are specified, the execution will ignore the **-Max** value and provide enough resources to accommodate the **-Min** requirement, in order to provide consistency in execution of apps described using either sbg:draft-2 or 1.0 version of CWL. Finally, if **sbg:CPURequirement** or **sbg:MemRequirement** are evaluated along with the corresponding CWL 1.0 **-Min** requirements (**coresMin** or **ramMin**), the execution will use the higher of these two values as the required number of cores or amount of RAM.\n\nDisk space requirements introduced in CWL 1.0 (**tmpdirMin** / **tmpdirMax** and **outdirMin** / **outdirMax**) are unfortunately not currently supported by the CGC.","excerpt":"","slug":"list-of-execution-hints","type":"basic","title":"List of execution hints"}

GET STARTED

TUTORIALS

ACCESS THE CGC

MANAGE AN ANALYSIS ENVIRONMENT

COLLABORATE SECURELY

DATASETS HUB

PUBLIC PROJECTS

BRING YOUR PRIVATE DATA

SET METADATA ASSOCIATED WITH A PRIVATE FILE

SEARCH FILES

ADD FILES TO A PROJECT

ORGANIZE FILES

ARCHIVE FILES

FIND APPS

RABIX OVERVIEW

DOCKER

DESCRIBE YOUR TOOL (LEGACY)

TOOL WRAPPING TIPS AND TRICKS

EDIT AN APP (LEGACY)

ARCHIVE APPS

RUN AN ANALYSIS

TASK EXECUTION

REVIEW A TASK

VIEW ANALYSIS RESULTS

INTERACTIVE ANALYSIS

DOWNLOAD RESULTS

DEVELOPER TOOLS

CONNECT CLOUD STORAGE

API Hub

API CLIENTS

SB Command Line Interface

API Reference

EDIT AN APP

BULK API ACTIONS

ASYNC BULK ACTIONS

DRS API

WATCH AND LEARN

DATA CRUNCHER

SBFS (Beta)

SBFS Command Reference

List of execution hints

[block:parameters] { "data": { "h-0": "Hint name", "h-1": "Workflow level", "h-2": "Node level", "h-3": "Tool level", "h-4": "Default", "h-5": "Notes", "h-6": "See also", "0-0": "`sbg:CPURequirement`<sup>1</sup>\nAllocates this many CPU cores for the execution of the tool.", "1-2": ":no-entry-sign:", "0-3": ":white-check-mark:", "2-4": "Decided by the scheduling algorithm", "2-5": ":warning: The task will fail if the resources available on the instance are insufficient for any tool in the workflow.", "0-2": ":no-entry-sign:", "0-1": ":no-entry-sign:", "0-4": "1", "0-5": "Accepts dynamic expressions", "0-6": "[Tool resource requirements](doc:about-tool-resource-requirements)", "1-1": ":no-entry-sign:", "1-3": ":white-check-mark:", "2-1": ":white-check-mark:", "2-2": ":white-check-mark:", "2-3": ":white-check-mark:", "3-1": ":white-check-mark:", "4-3": ":white-check-mark:", "3-2": ":no-entry-sign:", "3-3": ":no-entry-sign:", "4-1": ":no-entry-sign:", "4-2": ":no-entry-sign:", "3-5": ":warning: If a step is an inner workflow, its `sbg:maxNumberOfParallelInstances` will be overridden with the value from the outer workflow, even if it has not been set explicitly (*i.e.* the default value takes precedence).", "1-5": "Accepts dynamic expressions", "1-4": "1024 [MB]", "3-4": "1", "4-4": "file name", "1-0": "`sbg:MemRequirement`<sup>1</sup>\nAllocates this much MB of RAM for the execution of the tool.", "2-0": "`sbg:AWSInstanceType`\nConfigures the type of all the AWS instances provisioned for this workflow/node/tool.\nPriority: \n*workflow > node > tool*", "3-0": "`sbg:maxNumberOfParallelInstances`\nSets the maximum number of instances that can run in parallel for workflow execution.", "4-0": "`sbg:SaveLogs`\nConfigures the additional files to preserve as logs inside the project", "1-6": "[Tool resource requirements](doc:about-tool-resource-requirements)", "2-6": "[Available AWS instances](doc:list-of-available-amazon-web-services-instances)" }, "cols": 7, "rows": 5 } [/block] <sup>1</sup> The hints prefixed with **sbg:** are specific for the Seven Bridges execution environment. CWL 1.0 introduces **coresMin** / **coresMax** (minimum and maximum number of CPU cores) and **ramMin** / **ramMax** (minimum and maximum amount of RAM) in [resource requirements](http://www.commonwl.org/v1.0/CommandLineTool.html#ResourceRequirement), which can be found on any level (**Workflow**, **Step**, **Tool**). If your CWL 1.0 app description contains only the **-Min** or the **-Max** value, the Seven Bridges execution environment will use the specified value as the number of cores or amount of RAM required for execution. If both the **-Min** and the **-Max** value are specified, the execution will ignore the **-Max** value and provide enough resources to accommodate the **-Min** requirement, in order to provide consistency in execution of apps described using either sbg:draft-2 or 1.0 version of CWL. Finally, if **sbg:CPURequirement** or **sbg:MemRequirement** are evaluated along with the corresponding CWL 1.0 **-Min** requirements (**coresMin** or **ramMin**), the execution will use the higher of these two values as the required number of cores or amount of RAM. Disk space requirements introduced in CWL 1.0 (**tmpdirMin** / **tmpdirMax** and **outdirMin** / **outdirMax**) are unfortunately not currently supported by the CGC.