Description Usage Format Fields
Applications are a self-describing representation of an executable software item. See the <a href="http://agaveapi.co/documentation/tutorials/app-management-tutorial/">App Management Tutorial</a> for more information.
1 |
An object of class R6ClassGenerator of length 24.
availableWhether the application is available.
checkpointableWhether the application supports checkpointing.
defaultMaxRunTimeThe max execution time that should be used if none is given in a job description. Ignore if the system does not support schedulers.
defaultMemoryPerNodeThe default memory in GB to pass to the scheduler if none is given in the job description. This must be less than the max memory parameter in the target queue definition.
defaultNodeCountThe number of nodes that should be used if none is given in a job description. Ignore if the system does not support schedulers.
defaultProcessorsPerNodeThe number of processors to pass to the scheduler if none are given in the job description. This must be 1 if the app is serial.
defaultQueueThe queue on the execution system that should be used if none is given in a job description. Ignore if the system does not support schedulers.
deploymentPathThe location in default storage system containing the application wrapper and dependencies of the user
deploymentSystemThe system id of the storage system where this app should run.
executionSystemThe system id of the execution system where this app should run.
executionTypeThe execution type of the application. If you're unsure, it's probably HPC.
helpURIThe URL where users can go for more information about the app.
idUnique id of this app. Comprised of the app name-version.
iconThe icon to associate with this app.
inputsThe inputs files for this application.
labelThe label to use when generating forms.
lastModifiedThe date this application was last modified in ISO 8601 format.
longDescriptionThe full text description of this input to use when generating forms.
modulesAn array of modules to load prior to the execution of the application.
nameThe name of the application. The name does not have to be unique, but the combination of name and version does.
ontologyAn array of ontology values describing this application.
outputsThe outputs files for this application.
parallelismThe parallelism type of the application. If you're unsure, it's probably SERIAL.
parametersThe inputs parameters for this application.
isPublicWhether the application is public or private.
revisionThe number of times this application has been revised.
shortDescriptionThe short description of this application.
tagsAn array of tags related to this application.
templatePathThe path to the wrapper script relative to the deploymentPath.
testPathThe path to the test script relative to the deploymentPath.
uuidThe UUID of this application. UUID are 36 alphanumeric string.
versionThe version of the application in #.#.# format. While the version does not need to be unique, the combination of name and version does have to be unique.
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.