From 6199a922d3c886ff8b401516dea04c81cdc03f8f Mon Sep 17 00:00:00 2001 From: Hendrik Ranocha Date: Wed, 21 Feb 2024 13:24:04 +0100 Subject: [PATCH 1/3] Update benchmarking docs --- docs/src/performance.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/docs/src/performance.md b/docs/src/performance.md index 82d7f501f63..c1fe49c47f7 100644 --- a/docs/src/performance.md +++ b/docs/src/performance.md @@ -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 From 74557fbc49b61dd259a94ba4b932d23a2e57214e Mon Sep 17 00:00:00 2001 From: Hendrik Ranocha Date: Wed, 21 Feb 2024 13:25:34 +0100 Subject: [PATCH 2/3] Update performance.md --- docs/src/performance.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/src/performance.md b/docs/src/performance.md index c1fe49c47f7..5e265b26c38 100644 --- a/docs/src/performance.md +++ b/docs/src/performance.md @@ -116,7 +116,7 @@ To benchmark the changes made in a PR, please proceed as follows: 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 +!!! 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). From 2d256c514a88464f2dfa86210f574f6f1745bb30 Mon Sep 17 00:00:00 2001 From: Hendrik Ranocha Date: Thu, 22 Feb 2024 13:49:03 +0100 Subject: [PATCH 3/3] Update docs/src/performance.md Co-authored-by: Daniel Doehring --- docs/src/performance.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/src/performance.md b/docs/src/performance.md index 5e265b26c38..40970e58c5c 100644 --- a/docs/src/performance.md +++ b/docs/src/performance.md @@ -113,7 +113,7 @@ To benchmark the changes made in a PR, please proceed as follows: 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 +This will take some hours to complete and requires at least 8 GiB of RAM. When everything is finished, some output files will be created in the `benchmark` directory of Trixi.jl. !!! warning