https://github.com/lilithhafner/chairmarksforairspeedvelocity.jl

https://github.com/lilithhafner/chairmarksforairspeedvelocity.jl

Last synced: 3 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/lilithhafner/chairmarksforairspeedvelocity.jl
• Owner: LilithHafner
• License: other
• Created: 2025-01-12T22:03:07.000Z (4 months ago)
• Default Branch: main
• Last Pushed: 2025-01-28T23:16:17.000Z (4 months ago)
• Last Synced: 2025-01-29T00:21:15.657Z (4 months ago)
• Language: Julia
• Size: 221 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# ChairmarksForAirspeedVelocity

[![Build Status](https://github.com/LilithHafner/ChairmarksForAirspeedVelocity.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/LilithHafner/ChairmarksForAirspeedVelocity.jl/actions/workflows/CI.yml?query=branch%3Amain)

[![Coverage](https://codecov.io/gh/LilithHafner/ChairmarksForAirspeedVelocity.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/LilithHafner/ChairmarksForAirspeedVelocity.jl)

[![PkgEval](https://JuliaCI.github.io/NanosoldierReports/pkgeval_badges/C/ChairmarksForAirspeedVelocity.svg)](https://JuliaCI.github.io/NanosoldierReports/pkgeval_badges/C/ChairmarksForAirspeedVelocity.html)

[![Aqua](https://raw.githubusercontent.com/JuliaTesting/Aqua.jl/master/badge.svg)](https://github.com/JuliaTesting/Aqua.jl)

This package allows folks to use benchmarks defined by

[Chairmarks.jl](https://github.com/LilithHafner/Chairmarks.jl) with

[AirspeedVelocity.jl](https://github.com/MilesCranmer/AirspeedVelocity.jl) even though

AirspeedVelocity expects benchmarks defined by

[BenchmarkTools.jl](https://github.com/JuliaCI/BenchmarkTools.jl).

You might want to use this package to gain the performance of `Chairmarks.jl` while still

using the features of `AirspeedVelocity.jl`.

## Usage

Put this code in `benchmark/benchmarks.jl` and commit it to your default branch

```julia

using ChairmarksForAirspeedVelocity

const SUITE = BenchmarkGroup()

SUITE["main"]["random_sleep"] = @benchmarkable rand sleep evals = 1 samples = 2

```

Install `AirspeedVelocity.jl` with `Pkg.add("AirspeedVelocity"); Pkg.build("AirspeedVelocity")`

Run `~/julia/bin/benchpkg --add https://github.com/LilithHafner/ChairmarksForAirspeedVelocity.jl --rev dirty,main` (or add `~/julia/bin` to your `PATH` and run `benchpkg`)

`@benchmarkable ...` behaves like `() -> @be ...`. See the

[Chairmarks.jl documentation](https://chairmarks.lilithhafner.com/stable/)

for more information on defining benchmarks and the

[AirspeedVelocity documentation](https://astroautomata.com/AirspeedVelocity.jl/stable/)

for more information on using `AirspeedVelocity.jl` to analyze benchmarks.