Skip to content

Commit

Permalink
Add conclusions and keypoints
Browse files Browse the repository at this point in the history
  • Loading branch information
zsweger authored Sep 10, 2024
1 parent 7488134 commit 18ad82a
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion _episodes/03-making_useful_figures.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,9 @@ questions:
objectives:
- "Learn what information is useful to ePIC in developing benchmark artifacts and figures"
keypoints:
- "Clearly-labeled figures showing both physics results and detector performance plots will be helpful during detector and software development."
- "Aim for paper-ready benchmark figures whenever possible"
- "Clearly label plots with simulation details, and clear axis labels and legends"
- "If possible, augment the benchmark with an additional explainer document which describes figures in greater detail"
---

We've discussed how to plug your analysis script into GitLab's CI, and monitor it using pipelines. We'll now briefly discuss how to make figures for your benchmark that are useful to both yourself and to others.
Expand Down Expand Up @@ -119,3 +121,15 @@ After pushing these changes, check [GitLab's pipelines](https://eicweb.phy.anl.g

<img src="{{ page.root }}/fig/benchmark_explainer_artifact.png" alt="Benchmark explainer artifact" width="1000" style="box-shadow: 5px 5px 15px rgba(0, 0, 0, 0.3);">


## Conclusion

We've discussed ways to make benchmark figures legible and useful to others.

Analyzers should aim to make paper-ready figures that others can use and easily understand.

Including an explainer artifact which describes each figure in detail is encouraged. To do this:
- Copy [`bench.tex`](https://github.com/eic/tutorial-developing-benchmarks/blob/gh-pages/files/bench.tex) and [`bench.cls`](https://github.com/eic/tutorial-developing-benchmarks/blob/gh-pages/files/bench.cls) to your benchmark: `physics_benchmarks/benchmarks/your_bench/`
- Edit `bench.tex` with descriptions of each benchmark figure
- Add a rule (shown above) to your `Snakefile` to compile `bench.tex` and copy the resulting pdf to the `results` directory
- Check [GitLab's pipelines](https://eicweb.phy.anl.gov/EIC/benchmarks/physics_benchmarks/-/pipelines) for the pdf.

0 comments on commit 18ad82a

Please sign in to comment.