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.
available
Whether the application is available.
checkpointable
Whether the application supports checkpointing.
defaultMaxRunTime
The max execution time that should be used if none is given in a job description. Ignore if the system does not support schedulers.
defaultMemoryPerNode
The 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.
defaultNodeCount
The number of nodes that should be used if none is given in a job description. Ignore if the system does not support schedulers.
defaultProcessorsPerNode
The 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.
defaultQueue
The 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.
deploymentPath
The location in default storage system containing the application wrapper and dependencies of the user
deploymentSystem
The system id of the storage system where this app should run.
executionSystem
The system id of the execution system where this app should run.
executionType
The execution type of the application. If you're unsure, it's probably HPC.
helpURI
The URL where users can go for more information about the app.
id
Unique id of this app. Comprised of the app name-version.
icon
The icon to associate with this app.
inputs
The inputs files for this application.
label
The label to use when generating forms.
lastModified
The date this application was last modified in ISO 8601 format.
longDescription
The full text description of this input to use when generating forms.
modules
An array of modules to load prior to the execution of the application.
name
The name of the application. The name does not have to be unique, but the combination of name and version does.
ontology
An array of ontology values describing this application.
outputs
The outputs files for this application.
parallelism
The parallelism type of the application. If you're unsure, it's probably SERIAL.
parameters
The inputs parameters for this application.
isPublic
Whether the application is public or private.
revision
The number of times this application has been revised.
shortDescription
The short description of this application.
tags
An array of tags related to this application.
templatePath
The path to the wrapper script relative to the deploymentPath.
testPath
The path to the test script relative to the deploymentPath.
uuid
The UUID of this application. UUID are 36 alphanumeric string.
version
The 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.