Skip to content

Commit a672fc6

Browse files
committed
Add an example of the output to README.md
Also fix the build status badge.
1 parent 903f04a commit a672fc6

2 files changed

Lines changed: 16 additions & 1 deletion

File tree

README.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# TimerOutputsComparisons
22

3-
[![Build Status](https://github.com/johnomotani/TimerOutputsComparisons.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/johnomotani/TimerOutputsComparisons.jl/actions/workflows/CI.yml?query=branch%3Amain)
3+
[![Build Status](https://github.com/johnomotani/TimerOutputComparisons.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/johnomotani/TimerOutputComparisons.jl/actions/workflows/CI.yml?query=branch%3Amain)
44

55
Provides some helper functions to save/load TimerOutput objects, and plot
66
comparisons of them. This may be useful to compare performance with different
@@ -38,3 +38,18 @@ each timer can be plotted with `averages=true`. For example
3838
compare_timers(["foo$dt.jld" for dt delay_times]...; include=:time,
3939
legend=false, averages=true)
4040
```
41+
42+
Example output
43+
--------------
44+
45+
Below is the output from comparing runs of a parallelised matrix solver code on
46+
different numbers of cores, using
47+
```julia
48+
julia> using TimerOutputComparisons, TimerOutputs
49+
50+
julia> compare_timers("timing-1-1.jld", "timing-2-2.jld", "timing-4-4.jld", "timing-8-8.jld", "timing-16-16.jld"; use_data=:time, legend=false, averages=true, root="Static condensation ldiv! 16641")
51+
```
52+
where the legend is suppressed because there are too many entries - the curves
53+
can still be identified using the tooltip that appears when hovering the cursor
54+
over the curve.
55+
![Example of plot produced by TimerOutputComparisons.jl](doc/example-scaling-performance.png)
359 KB
Loading

0 commit comments

Comments
 (0)