Skip to content

Commit

Permalink
Update benchmarking docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ranocha authored Feb 21, 2024
1 parent 1b2abd0 commit 6199a92
Showing 1 changed file with 16 additions and 1 deletion.
17 changes: 16 additions & 1 deletion docs/src/performance.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,22 @@ resulting performance improvements of Trixi.jl are given in the following blog p
We use [PkgBenchmark.jl](https://github.com/JuliaCI/PkgBenchmark.jl) to provide a standard set of
benchmarks for Trixi.jl. The relevant benchmark script is
[benchmark/benchmarks.jl](https://github.com/trixi-framework/Trixi.jl/blob/main/benchmark/benchmarks.jl).
You can run a standard set of benchmarks via
To benchmark the changes made in a PR, please proceed as follows:

1. Check out the latest `main` branch of your Trixi.jl development repository.
2. Check out the latest development branch of your PR.
3. Change your working directory to the `benchmark` directory of Trixi.jl.
4. Execute `julia run_benchmarks.jl`.

This will take some hours to complete. When everything is finished, some
output files will be created in the `benchmark` directory of Trixi.jl.

!!! note
Please note that the benchmark scripts use `--check-bounds=no` at the moment.
Thus, they will not work in any useful way for Julia v1.10 (and newer?), see
[Julia issue #50985](https://github.com/JuliaLang/julia/issues/50985).

You can also run a standard set of benchmarks manually via
```julia
julia> using PkgBenchmark, Trixi

Expand Down

0 comments on commit 6199a92

Please sign in to comment.