layout | title | tagline |
---|---|---|
page |
Create a Custom Application |
NOTE: The app building guide presented here is a work in progress, and it uses a development branch of the SD2E CLI. Please proceed with caution. If you would instead prefer to follow the old, but safe, app building guide, please go here
You can find Agave applications ("apps") in the SD2E catalog by using the apps-list
command described previously. What if the app you are
looking for is not available? Using the Agave CLI, you can create your own.
#### Components of an app
The essential components you need to create your own app are:
- An app bundle directory containing definitions and assets for the app
- A Docker image containing the executable and all runtime dependencies
- A wrapper script (generally written in bash) that runs the executable
Several example apps exist and all components are visible. For example, visit the SD2E Docker Hub to view existing app containers. And, example app bundles can be viewed on the SD2E GitHub page or SD2E GitLab.
#### Create your own by example
The best way to demonstrate the creation of a custom app is by example. The following sub-pages will go through the process:
- Set up your environment
- Initiate the app directory
- Containerize the executable
- Deploy and submit a test job
- Best practices and next steps
Return to the API Documentation Overview