Skip to content

chef_guide.md

Latest commit

 

History

History
55 lines (39 loc) · 2.54 KB

chef_guide.md

File metadata and controls

55 lines (39 loc) · 2.54 KB

Chefs' Guide for Timeline Production

The timeline code is provided on ifarm via module load timeline. Please report any issues to the software maintainers, such as warnings or error messages.

🟢 Step 1: Fill Timeline Histograms

This step is integrated in the cooking workflow using the "qtl" model; see the Chefs' documentation wiki for details. Output files will appear in your chosen output directory, within hist/detectors/.

If you are not using the cooking workflow...

See the detailed procedure's Step 1 instead. The cooking workflow's "qtl" model just runs qtl histogram with the appropriate arguments.

For physics QA timelines...

Note: we are working on combining the procedure for physics timelines with that for detector timelines; until then, to get the full set of physics timelines, the procedure is separate. For Step 1, either:

  • Use the --physics option with the workflow "qtl" model
  • Use qtl histogram instead of the workflow, with the option --focus-physics; this will run on SLURM directly (rather than through SWIF)

🟢 Step 2: Analyze Histograms and Make the Timelines

In general, run:

qtl analysis -i $out_dir/hist/detectors -p $publish_dir

where $out_dir is the output directory from Step 1 and $publish_dir is the publishing directory to clas12mon. Additional options may be needed for your specific dataset, so check the usage guide by running with no arguments:

qtl analysis

A URL will be printed upon success, and a link will appear in clas12mon in your run group's area momentarily.

For physics QA timelines...

Run qtl physics instead of qtl analysis; its options are similar.

Tip

Step 2 runs on an interactive node and can take some time if there are a lot of data. We recommend using tools such as tmux terminal multiplexer or GNU Screen to keep the job running if you lose your SSH connection.

Tip

Step 2 produces temporary files, by default in a subdirectory of ./outfiles/. Consider making a symbolic link named outfiles pointing to somewhere on /volatile.

For more details, see other guides in the table of contents or reach out to the software maintainers.