merge queue: embarking main (c84a96b) and #2400 together

benchmarks/check_asv.sh

@@ -0,0 +1,9 @@
+source env/bin/activate #or change to your env path
+git pull upstream main
+sudo cpufreq-set -c 3 -g performance
+#asv does recent commits first, so by letting it run for 55min, and the cron to 1hr
+#it will always keep up with new commits, but also process the backlog
+timeout 3300s asv run -j 4 --show-stderr --cpu-affinity 3 --skip-existing ALL
+sudo cpufreq-set -c 3 -g powersave
+asv publish
+asv preview

docs/development.md

@@ -759,13 +759,12 @@ on how to write and run these tests.
 
 Benchmarks to measure performance are in the `benchmarks` folder and are run using
 [airspeed velocity](https://asv.readthedocs.io/en/stable/index.html).
-An automated system runs the benchmarks on each push to the main branch and uploads
-the results to [this github pages site](https://tskit-dev.github.io/msprime-asv).
+A system that runs the benchmarks on each push to the main branch.
 These benchmarks can also be run locally to compare your branch with the main branch.
 Your changes must be in a commit to be measured. To run the benchmarks:
 
 ```
-asv run asv run HEAD...main~1
+asv run HEAD...main~1
 ```
 
 This will run the benchmarks for the latest main branch commit and all commits on
@@ -787,6 +786,9 @@ Note the following tips:
   development version. This can lead to confusing results! When tuning
   benchmarks it's better to commit often and use (e.g.)
   `asv run HEAD^! --show-stderr -b Hudson.time_large_sample_size`.
+- You may want to benchmark a specific list of commits exclusively. To do so, put the commits' hashes in a file and use the command: `asv run --show-stderr --skip-existing HASHFILE:hashestobenchmark.txt`
+
+- There is a script: `benchmarks/check_asv.sh` that can be used to benchmark recent commits.
 
 ## Containerization
 

requirements/development.txt

@@ -1,5 +1,5 @@
 docutils==0.21.2  # issue with 0.17, https://github.com/tskit-dev/msprime/issues/1625
-asv
+asv==0.6.1
 bintrees
 coverage
 daiquiri