From 5e75059537d7e678326ed8dc80f8d56d06ae8a13 Mon Sep 17 00:00:00 2001 From: Melody Lee Date: Wed, 18 Dec 2024 08:42:13 -0500 Subject: [PATCH] Update documentation on axis labeling for figures to includes notes on siunitx and binop --- group-syllabus/figures.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/group-syllabus/figures.md b/group-syllabus/figures.md index 685091f..4c87645 100644 --- a/group-syllabus/figures.md +++ b/group-syllabus/figures.md @@ -137,7 +137,7 @@ Do not show the coordinate direction arrows (usually x, y, z) included in Paravi An exception might be creating a simulation video that requires the viewer to know these orientations. If you are exporting an image, superimpose your own direction triad if needed. -### Axis bounds +### Axis labeling Your axes should, whenever possible, start and end at labeled tick marks. This is especially important for log-scale axes. @@ -147,6 +147,10 @@ In pgfplots, this is achieved with the options: Avoid excessive text in tick marks when possible. For example, use `1, 2, 3, 4, 5` in units of `kHz` instead of `1000, 2000, 300, 4000, 5000` in units of `Hz`. +In `tikz_preamble.tex`, the package `siunitx` is imported. If possible, use this to format your units. For example, if your units are in microseconds ($\mu \textrm{s}$), use `\unit{\micro\second}`. To access documentation on `siunitx`, visit [the package webpage here](https://ctan.org/pkg/siunitx?lang=en). + +In some cases, Tikz will scale the axis label by some $k$-th power of $10$, indicated using $\cdot 10^n$. If possible, it would be preferable to replace the $\cdot$ symbol with $\times$. This may be done by ways of inserting the expression `tick scale binop=\times` in the axis environment. + ### Information quantity Your figures should only contain the information required to tell the story or demonstrate the desired results.