Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update benchmarking docs #1849

Merged
merged 3 commits into from
Feb 22, 2024
Merged

Update benchmarking docs #1849

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6199a92
Update benchmarking docs
ranocha Feb 21, 2024
74557fb
Update performance.md
ranocha Feb 21, 2024
2d256c5
Update docs/src/performance.md
ranocha Feb 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 16 additions & 1 deletion docs/src/performance.md
View file
Open in desktop
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.

!!! warning
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
Loading