Skip to content

Commit

Permalink
Update figures.md
Browse files Browse the repository at this point in the history
  • Loading branch information
sbryngelson authored Dec 18, 2024
1 parent 1f983c4 commit e1a9a7f
Showing 1 changed file with 11 additions and 4 deletions.
15 changes: 11 additions & 4 deletions group-syllabus/figures.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 labeling
### Axis bounds and ticks

Your axes should, whenever possible, start and end at labeled tick marks.
This is especially important for log-scale axes.
Expand All @@ -147,13 +147,20 @@ 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`.

### Axis labels

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.
For log-scale axes, be sure that you use actual quantities in the data you plot.
For example, do not label your axis as "$2^x$ Points" where $x$ is linearly plotted on the axis.
Log mode in pgfplots exists for a reason!

When naming your axes, ensure the chosen labels clearly convey what quantities or qualities they describe. For example, suppose you seek to indicate how your algorithm scales with the number of lattice sites. "Number of Lattice Sites" conveys this intention, albeit long. However, simply using "Lattice Sites" is unclear. Someone unfamiliar with the content may interpret this as referring to data describing different points on a given lattice.
In some cases, pgfplots 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.

It may be helpful to indicate that the axis is logarithmic by including "(log)" in the axis label.
When naming your axes, ensure the chosen labels clearly convey what quantities or qualities they describe, and in almost all cases one should include the math symbol that describes any text in the label.
For example, suppose you seek to indicate how your algorithm scales with the number of lattice sites.
"Number of Lattice Sites $N$" conveys this intention, albeit long, and simply using "Lattice Sites" is unclear.
Someone unfamiliar with the content may interpret this as referring to data describing different points on a given lattice.

### Information quantity

Expand Down

0 comments on commit e1a9a7f

Please sign in to comment.