Skip to content

Commit eec2722

Browse files
committed
doc: update chef guide
1 parent 7d101ce commit eec2722

1 file changed

Lines changed: 11 additions & 4 deletions

File tree

doc/chef_guide.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,22 +14,29 @@ see [the Chefs' documentation wiki](https://clasweb.jlab.org/wiki/index.php/CLAS
1414

1515
Output files will appear in your chosen output directory, within `hist/detectors/`.
1616

17+
> [!NOTE]
18+
> If you want physics timelines, for now you'll need to use `qtl histogram --focus-physics`; we will eventually include this in the workflow!
19+
1720
## :green_circle: Step 2: Make the timelines
1821

1922
```bash
2023
qtl analysis -d $dataset -i $out_dir/hist/detectors -p $publish_dir
2124
```
22-
- `$out_dir` is your output directory from **Step 1** and `$dataset` is a unique name for this cook, _e.g._, `rga_v1.23`.
25+
- `$dataset` is a unique name for this cook, _e.g._, `rga_v1.23`
26+
- `$out_dir` is your output directory from **Step 1**
2327
- `$publish_dir` is the publishing directory
2428
- example: `rgb/pass0`
29+
- note: the full publishing path will be `/group/clas/www/clas12mon/html/hipo/${publish_dir}/${dataset}`
2530

2631
A URL will be printed upon success, and a link will appear in [`clas12mon`](https://clas12mon.jlab.org/) in your run group's area momentarily.
2732

33+
> [!IMPORTANT]
34+
> Run `qtl analysis` with no further arguments for additional usage; some options may be _needed_ for your run group!
35+
2836
> [!TIP]
29-
> Step 2 generates analyzed timeline files and logging information to a
30-
> separate directory.
37+
> Step 2 generates analyzed timeline files and logging information to a separate directory.
3138
> - You can control that directory with the `-o` option, or just use the default.
32-
> - If using the default, consider making a symbolic link named `outfiles` pointing to somewhere on `/volatile`
39+
> - If using the default, consider making a symbolic link named `outfiles` pointing to somewhere on `/volatile`, since once timelines are published successfully, you don't really need these output files
3340
3441
---
3542

0 commit comments

Comments
 (0)