Skip to content
Snippets Groups Projects
Normal view History Permalink
README.md 1.41 KiB
Newer Older
William E Warriner's avatar
initial commit
William E Warriner committed
1 2 3 4 
# BASE FORM

The base form covering apps on UAB RC OOD 1.6
William E Warriner's avatar
add initial how-to in readme  
William E Warriner committed
5 
## How to Use
William E Warriner's avatar
initial commit
William E Warriner committed
6
William E Warriner's avatar
add initial how-to in readme  
William E Warriner committed
7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 
1. Make this repository part of your app's repository. If the app is new, cloning this is a good starting point.
2. Modify `form.yml.erb` starting at the final `form:` block. Set any "true" conditionals to "false" to turn off those features.

    - `desktop` set false if the app does not need a desktop (Jupyter needs "false").
    - `conda_extensions` set false if the app does not need conda extensions (Jupyter needs "true").
    - `custom_environment` set false if the app should not use a custom_environment entry field.
    - `extra_jupyter_args` set false if the app should not allow custom arguments to the command (Jupyter needs "true").
    - `version_1` set false if version selection is not required for software (RStudio needs "true").
    - `version_2` set false if version selection is not required for software (RStudio needs "true").

3. Configure `version_1` and `version_2` options as needed. Look for the comments with `VERSION SELECTOR 1`, for example.

## Dev

Create the Conda environment using `conda env install --file environment.yml` to configure ruby.

1. Test templates locally using `./test_erb.sh`.
2. Test your app on OOD by cloning the repo into the Sandbox app environment.
3. Test whether Slurm receives the correct variables from `script.sh.erb`. Running a job using the form should create a log file in the repo root directory.