Developers

AweSim on Open OnDemand Documentation

1. Developing on apps-test.awesim.org
2. Porting an existing app to OOD
3. Sharing apps in OOD
4. OOD Gem Changes
5. Building new apps - see https://github.com/AweSim-OSC/rails-application-template/tree/remote_source - we will update this soon

Legacy documentation

Some of these links are on GitHub (external to AweSim) and require permission to access. If you do not have access, GitHub will hide the page with a "404". This is not a broken link. Please contact OSC Help if you want access granted.

Getting started

• Onboarding OSC systems - Familiarize yourself with OSC's systems

• Getting started with dev sandbox

• Create a new app with AppKit 1.0 - Tutorial on building a simple app

• Rationale for RAILS_DATAROOT - how shared applications run as the user and store the user's data in their own space

Sharing Apps

1. Use the awesim CLI to share an app using awesim setup and awesim lint
2. Manage access to a shared app using awesim permission
3. Update a shared app - using awesim update, awesim restart, and awesim maintenance

How to

• Fixing broken links to results files
• Adding File Upload Caching for File Attachments
  • this will eventually be merged as a feature in a future version of the app kit
• Accessing Output and Error files
  • best practice for making job log files available to users through your app
• Where to store results and how to make them URL accessible
• Resolving the file path to a results file of a simulation
• Resolving the URL to a results file of a simulation
• Validating the results of a simulation
• Managing public/.htaccess
  • do this after cloning an app or creating a new app under ~/awesim_dev/
• Setting and modifying the application root
• Updating an App to Enable Sharing
  • Do this if you built an app before app sharing was introduced (pre App Kit 1.0).

Troubleshooting

• Problem submitting jobs from command line or rails console - temporary issue till we switch to new web infrastructure in the Spring

• Sandbox app is running in production mode - how to ensure your sandbox/development (rails1-9) is running in development mode

• Problems accessing shared app - your app works in sandbox/development but when you share the app you experience problems accessing it

• Results are not accessible from the app - make sure to save user's results files to the right place!

• Assets not loading in production

App Kit 1.0

• Release Notes for AppKit 1.0
• Porting an existing app to AppKit 1.0

Gems

For building a web app:

• osc_machete_rails gem - docs - enable Rails apps to manage batch simulations using simulation templates

  • osc_machete_rails stages simulations to a unique directory

• ood_appkit - Provides dataroot and application and numerous helper methods for system accessibility applications.

• awesim_branding Provides an AweSim branded header and backward compatibility for applications created with awesim_rails gem.

• awesim_rails DEPRECATED AweSim branding and dataroot manipulation. Replaced by ood_appkit and awesim_branding

• awesim_rails_logging - provide custom formatter to tag production logs with user and app token. We will eventually use this to provide developers access to logs of the users of their apps.

• rails-application-template - use to generate a new app using the command awesim rails new

Utility:

• osc-vnc gem - docs - help launch vnc sessions on compute nodes and Oxymoron cluster
• osc-reservations gem - docs - this is currently broken - provide read-only information about the reserved nodes you have access to

Dependencies:

• osc-machete gem - docs - submit, check the status, setup dependencies, and stop batch jobs; a generic interface that sits in front of pbs-ruby
• osc_machete_rails gem - docs - Build and manage simulation workflows.
• pbs-ruby gem - docs - provide Ruby interface to Torque libraries

Example Apps

• containerfillsim - example Rails app that uses osc-machete to submit simulation templates and osc-vnc to visualize results using Paraview