Skip to content

Commit

Permalink
Update CONTRIBUTING.md with further information on how to run the ben…
Browse files Browse the repository at this point in the history
…chmarking
  • Loading branch information
MarionBWeinzierl authored Dec 2, 2024
1 parent 871f7a5 commit 932a7cf
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,8 +99,16 @@ details on the workflow and process.
Even if the code works as expected and passes all our tests, it can still be slow! We
use code profiling to work out where time is spent when using `pyrealm` and identify
where we can improve performance. We also use benchmarking between `pyrealm` versions to
make sure that changes to the code aren't making it slower. This is currently run
manually using the `performance_regression_checking.sh` script in the `profiling` directory.
make sure that changes to the code aren't making it slower.

This is currently runmanually using the `performance_regression_checking.sh` script in
the `profiling` directory. When this bash script is run without an argument, the current
`HEAD` will be compared to the `origin/develop` branch. Alternatively, the two commits
to be compared can be provided as parameters with `-n` for the "new" commit (the current
HEAD, or code you have changed), and `-o` for the "old" commit (the baseline code you
want to compare the perfomance against). The code will fail with an error message if the
new performance is more than 5% slower than the baseline, otherwise it will succeed with
a message indicating whether the new code is faster or has similar performance.

### Documentation

Expand Down

0 comments on commit 932a7cf

Please sign in to comment.