Skip to content

Commit 77ccdee

Browse files
committed
Readme updates for thea
1 parent 9028963 commit 77ccdee

File tree

3 files changed

+152
-14
lines changed

3 files changed

+152
-14
lines changed

workflows/nt3_mlrMBO/README.md

Lines changed: 50 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -286,22 +286,68 @@ cd Supervisor/workflows/nt3_mlrMBO/ext/EQ-R/eqr
286286

287287
Launching the workflow:
288288

289-
Edit
290-
`cori_workflow3.sh` setting the relevant variables as appropriate. All easily
289+
1. Make a copy of `cori_workflow3.sh`
290+
2. Edit the copy setting the relevant variables there
291+
as appropriate. All easily
291292
changed settings are delineated by the `USER SETTINGS START` and `USER SETTINGS END`
292293
markers. Note that these variables can be easily overwritten from the calling
293294
environment (use `export` in your shell). By default these are set up for a short-ish
294295
debugging runs and will need to be changed for a production run.
296+
3. `source cori_settings.sh`
297+
4. Run the workflow by running your workflow script, passing an experiment id.
295298

296299
An example:
297300

298301
```
299302
cd Supervisor/workflows/nt3_mlrMBO/swift
303+
cp cori_workflow3.sh my_cori_workflow.sh
304+
# edit my my_cori_workflow.sh
300305
source cori_settings.sh
301-
./cori_workflow.sh T1
306+
./my_cori_workflow.sh T1
302307
```
303308
where T1 is the experiment ID.
304309

305310
### Running on Theta ###
306311

307-
TODO
312+
* Download, install etc. the user requirements listed at the top of this
313+
document.
314+
315+
All the system requirements (see above) have been installed on Theta for except
316+
for the EQ/R swift extension.
317+
318+
* Compile the EQ/R swift-t extension.
319+
```
320+
cd Supervisor/workflows/nt3_mlrMBO/ext/EQ-R/eqr
321+
./bootstrap
322+
source ./theta_build_settings.sh
323+
./configure
324+
make install
325+
```
326+
327+
Launching the workflow:
328+
329+
1. Make a copy of `theta_workflow.sh`
330+
2. Edit the copy setting the relevant variables there
331+
as appropriate. All easily
332+
changed settings are delineated by the `USER SETTINGS START` and `USER SETTINGS END`
333+
markers. Note that these variables can be easily overwritten from the calling
334+
environment (use `export` in your shell). By default these are set up for a short-ish
335+
debugging runs and will need to be changed for a production run.
336+
3. Run the workflow by running your workflow script, passing an experiment id.
337+
338+
An example:
339+
340+
```
341+
cd Supervisor/workflows/nt3_mlrMBO/swift
342+
cp theta_workflow.sh my_theta_workflow.sh
343+
# edit my theta_workflow.sh if necesasry
344+
./theta_workflow.sh T1
345+
```
346+
347+
where T1 is the experiment ID.
348+
349+
Note that Theta use the _ai_-version of the workflow. The benchmark is launched
350+
using Supervisor/workflows/nt3_mlrMBO/scripts/theta_run_model.sh. In there, the
351+
`PYTHONHOME` shell variable can be changed to specify a different python installation to
352+
run the model with. If you do change the python installation, the python
353+
system requirements mentioned above will need to be satisfied.

workflows/p2b1_mlrMBO/README.md

Lines changed: 50 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -302,22 +302,68 @@ cd Supervisor/workflows/p2b1_mlrMBO/ext/EQ-R/eqr
302302

303303
Launching the workflow:
304304

305-
Edit
306-
`cori_workflow3.sh` setting the relevant variables as appropriate. All easily
305+
1. Make a copy of `cori_workflow3.sh`
306+
2. Edit the copy setting the relevant variables there
307+
as appropriate. All easily
307308
changed settings are delineated by the `USER SETTINGS START` and `USER SETTINGS END`
308309
markers. Note that these variables can be easily overwritten from the calling
309310
environment (use `export` in your shell). By default these are set up for a short-ish
310311
debugging runs and will need to be changed for a production run.
312+
3. `source cori_settings.sh`
313+
4. Run the workflow by running your workflow script, passing an experiment id.
311314

312315
An example:
313316

314317
```
315318
cd Supervisor/workflows/p2b1_mlrMBO/swift
319+
cp cori_workflow3.sh my_cori_workflow.sh
320+
# edit my my_cori_workflow.sh
316321
source cori_settings.sh
317-
./cori_workflow.sh T1
322+
./my_cori_workflow.sh T1
318323
```
319324
where T1 is the experiment ID.
320325

321326
### Running on Theta ###
322327

323-
TODO
328+
* Download, install etc. the user requirements listed at the top of this
329+
document.
330+
331+
All the system requirements (see above) have been installed on Theta for except
332+
for the EQ/R swift extension.
333+
334+
* Compile the EQ/R swift-t extension.
335+
```
336+
cd Supervisor/workflows/p2b1_mlrMBO/ext/EQ-R/eqr
337+
./bootstrap
338+
source ./theta_build_settings.sh
339+
./configure
340+
make install
341+
```
342+
343+
Launching the workflow:
344+
345+
1. Make a copy of `theta_workflow.sh`
346+
2. Edit the copy setting the relevant variables there
347+
as appropriate. All easily
348+
changed settings are delineated by the `USER SETTINGS START` and `USER SETTINGS END`
349+
markers. Note that these variables can be easily overwritten from the calling
350+
environment (use `export` in your shell). By default these are set up for a short-ish
351+
debugging runs and will need to be changed for a production run.
352+
3. Run the workflow by running your workflow script, passing an experiment id.
353+
354+
An example:
355+
356+
```
357+
cd Supervisor/workflows/p2b1_mlrMBO/swift
358+
cp theta_workflow.sh my_theta_workflow.sh
359+
# edit my theta_workflow.sh if necesasry
360+
./theta_workflow.sh T1
361+
```
362+
363+
where T1 is the experiment ID.
364+
365+
Note that Theta use the _ai_-version of the workflow. The benchmark is launched
366+
using Supervisor/workflows/p2b1_mlrMBO/scripts/theta_run_model.sh. In there, the
367+
`PYTHONHOME` shell variable can be changed to specify a different python installation to
368+
run the model with. If you do change the python installation, the python
369+
system requirements mentioned above will need to be satisfied.

workflows/p3b1_mlrMBO/README.md

Lines changed: 52 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -271,22 +271,68 @@ cd Supervisor/workflows/p3b1_mlrMBO/ext/EQ-R/eqr
271271

272272
Launching the workflow:
273273

274-
Use the cori_* files in the `swift` directory to launch the workflow. Edit
275-
`cori_workflow3.sh` setting the relevant variables as appropriate. All easily
276-
changed settings are delineated by the `USER SETTINGS START` and `USER SETTINGS END`
274+
1. Make a copy of `cori_workflow3.sh`
275+
2. Edit the copy setting the relevant variables there
276+
as appropriate. All easily
277+
changed settings are delineated by the `USER SETTINGS START` and `USER SETTINGS END`
277278
markers. Note that these variables can be easily overwritten from the calling
278-
environment (use `export` in your shell). By default these are set up for short
279+
environment (use `export` in your shell). By default these are set up for a short-ish
279280
debugging runs and will need to be changed for a production run.
281+
3. `source cori_settings.sh`
282+
4. Run the workflow by running your workflow script, passing an experiment id.
280283

281284
An example:
282285

283286
```
284287
cd Supervisor/workflows/p3b1_mlrMBO/swift
288+
cp cori_workflow3.sh my_cori_workflow.sh
289+
# edit my my_cori_workflow.sh
285290
source cori_settings.sh
286-
./cori_workflow.sh T1
291+
./my_cori_workflow.sh T1
287292
```
288293
where T1 is the experiment ID.
289294

290295
### Running on Theta ###
291296

292-
TODO
297+
* Download, install etc. the user requirements listed at the top of this
298+
document.
299+
300+
All the system requirements (see above) have been installed on Theta for except
301+
for the EQ/R swift extension.
302+
303+
* Compile the EQ/R swift-t extension.
304+
```
305+
cd Supervisor/workflows/p3b1_mlrMBO/ext/EQ-R/eqr
306+
./bootstrap
307+
source ./theta_build_settings.sh
308+
./configure
309+
make install
310+
```
311+
312+
Launching the workflow:
313+
314+
1. Make a copy of `theta_workflow.sh`
315+
2. Edit the copy setting the relevant variables there
316+
as appropriate. All easily
317+
changed settings are delineated by the `USER SETTINGS START` and `USER SETTINGS END`
318+
markers. Note that these variables can be easily overwritten from the calling
319+
environment (use `export` in your shell). By default these are set up for a short-ish
320+
debugging runs and will need to be changed for a production run.
321+
3. Run the workflow by running your workflow script, passing an experiment id.
322+
323+
An example:
324+
325+
```
326+
cd Supervisor/workflows/p3b1_mlrMBO/swift
327+
cp theta_workflow.sh my_theta_workflow.sh
328+
# edit my theta_workflow.sh if necesasry
329+
./theta_workflow.sh T1
330+
```
331+
332+
where T1 is the experiment ID.
333+
334+
Note that Theta use the _ai_-version of the workflow. The benchmark is launched
335+
using Supervisor/workflows/p3b1_mlrMBO/scripts/theta_run_model.sh. In there, the
336+
`PYTHONHOME` shell variable can be changed to specify a different python installation to
337+
run the model with. If you do change the python installation, the python
338+
system requirements mentioned above will need to be satisfied.

0 commit comments

Comments
 (0)