Skip to content

Commit 38eb199

Browse files
committed
modify toc for the ood tutorial
1 parent e5ef972 commit 38eb199

1 file changed

Lines changed: 20 additions & 14 deletions

File tree

ondemand/README.md

Lines changed: 20 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,21 @@
11
# Open OnDemand Tutorial
22

3+
## Table of Contents
4+
5+
Live tutorial steps we took during PEARC. See the PEARC video recording to follow along (with images and explanations!):
6+
37
- [Jupyter App Tutorial Summary](#jupyter-app-tutorial-summary)
4-
- [Jupyter App Tutorial](#jupyter-app-tutorial)
58
- [Passenger App Tutorial](#passenger-app-tutorial)
69
- [XDMoD Integration Tutorial](#xdmod-integration-tutorial)
710

11+
Detailed tutorials, for working through on your own time
12+
13+
- [Jupyter App Tutorial](#jupyter-app-detailed-tutorial)
14+
815
## External links
916

10-
* [Online Documentation](https://osc.github.io/ood-documentation/master/)
11-
* [Jupyter Install Tutorial](https://osc.github.io/ood-documentation/master/app-development/tutorials-interactive-apps/add-jupyter.html)
17+
- [Online Documentation](https://osc.github.io/ood-documentation/master/)
18+
- [Jupyter Install Tutorial](https://osc.github.io/ood-documentation/master/app-development/tutorials-interactive-apps/add-jupyter.html)
1219

1320
## Jupyter App Tutorial Summary
1421

@@ -24,12 +31,11 @@ Login to OnDemand as hpcadmin to https://localhost:3443
2431

2532
Fix environment: `source /usr/local/jupyter/2.1.4/bin/activate`
2633

27-
2834
### Modify the Partition field
2935

3036
form.yml changes:
3137

32-
```
38+
```yaml
3339
attributes:
3440
custom_queue:
3541
widget: "select"
@@ -44,7 +50,7 @@ form:
4450

4551
- `custom_queue` is used instead of `partition` because of 1.8 bug that will be fixed prior to release
4652

47-
script.yml.erb changes:
53+
submit.yml.erb changes:
4854

4955
```yaml
5056
script:
@@ -57,7 +63,7 @@ script:
5763
5864
Edit manifest:
5965
60-
```
66+
```yaml
6167
---
6268
# change the name, this is what shows up in the menu
6369
name: HPC Tutorial Jupyter
@@ -75,17 +81,18 @@ description: |
7581
7682
Deployment steps on ondemand host via Shell:
7783
84+
```shell
7885
sudo mv /var/www/ood/apps/sys/jupyter /var/www/ood/apps/sys/jupyter.old
7986
sudo cp -r jupyter /var/www/ood/apps/sys/jupyter
87+
```
8088

8189
- app directory names with periods in them do not display in the navbar, which is why we can rename the old app to jupyter.old
8290

83-
84-
### Set the memory for the job
91+
### Set the memory for the job
8592

8693
form.yml changes:
8794

88-
```
95+
```yaml
8996
attributes:
9097
memory:
9198
widget: "number_field"
@@ -110,7 +117,7 @@ form:
110117
111118
script.yml.erb modifications:
112119
113-
```
120+
```yaml
114121
script:
115122
native:
116123
- "--mem"
@@ -134,7 +141,7 @@ attributes:
134141
135142
form.yml:
136143
137-
```
144+
```yaml
138145
attributes:
139146
jupyterlab_switch:
140147
widget: "check_box"
@@ -147,11 +154,10 @@ form:
147154
148155
template script.sh:
149156
150-
```
157+
```ruby
151158
jupyter <%= context.jupyterlab_switch == "1" ? "lab" : "notebook" %> --config="${CONFIG_FILE}" <%= context.extra_jupyter_args %>
152159
```
153160
154-
155161
## Jupyter App Detailed Tutorial
156162
157163
This tutorial will be using the the `hpcadmin` credentials listed in

0 commit comments

Comments
 (0)