Skip to content

Commit 891f61f

Browse files
authored
doc: tersify more
1 parent 8910f20 commit 891f61f

1 file changed

Lines changed: 8 additions & 15 deletions

File tree

doc/chef_guide.md

Lines changed: 8 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,9 @@
11
# Chefs' Guide for Timeline Production
22

3-
The timeline code is provided on `ifarm` via
4-
```bash
5-
module load timeline
6-
```
3+
The timeline code is provided on `ifarm` via `module load timeline`.
74
Please report _any_ issues to the software maintainers, such as warnings or error messages.
85

9-
## Producing Timelines
10-
11-
### :green_circle: Step 1: Fill Timeline Histograms
6+
## :green_circle: Step 1: Fill Timeline Histograms
127

138
Use the "qtl" model as part of your usual cooking workflow; see [the Chefs' documentation wiki](https://clasweb.jlab.org/wiki/index.php/CLAS12_Chef_Documentation). Output files will appear in your chosen output directory, within `hist/detectors/`.
149

@@ -20,19 +15,17 @@ Use the "qtl" model as part of your usual cooking workflow; see [the Chefs' docu
2015
> - Use `qtl histogram` instead of the workflow, with the option `--focus-physics`; this will run on SLURM directly (rather than through SWIF)
2116
</details>
2217
23-
### :green_circle: Step 2: Analyze Histograms and Make the Timelines
18+
## :green_circle: Step 2: Analyze Histograms and Make the Timelines
2419

25-
Print the usage guide:
26-
```bash
27-
qtl analysis
28-
```
29-
In general,
20+
In general, run:
3021
```bash
3122
qtl analysis -i $out_dir/hist/detectors -p $publish_dir
3223
```
3324
where `$out_dir` is the output directory from **Step 1** and `$publish_dir` is the publishing directory to [`clas12mon`](https://clas12mon.jlab.org/).
34-
Additional options may be _needed_ for your specific dataset, so check the usage guide (run `qtl analysis`).
35-
25+
Additional options may be _needed_ for your specific dataset, so check the usage guide by running with no arguments:
26+
```bash
27+
qtl analysis
28+
```
3629
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.
3730

3831
<details>

0 commit comments

Comments
 (0)