JuliaDynamics / JuliaDynamics/ConcurrentSim.jl

add benchmarks to CI

Open
#112 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Julia
Stars
198
Forks
40
Avg merge
21h 40m
Merged PRs (30d)
2

Description

Currently we have a CI job that automatically tries to run benchmarks and detect regressions, but we have not actually added benchmarks scripts to the package.

To add them we can follow some of these examples:

https://github.com/JuliaDynamics/ResumableFunctions.jl/blob/master/benchmark/benchmarks.jl

https://github.com/QuantumSavory/QuantumSavory.jl/blob/master/benchmark/benchmarks.jl

https://github.com/QuantumSavory/QuantumClifford.jl/blob/master/benchmark/benchmarks.jl

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the existing benchmark CI job and comparing the benchmark/benchmarks.jl examples linked from ResumableFunctions.jl and QuantumSavory.jl. Add benchmark scripts for this package so the current CI job can execute them and detect regressions; done means the job runs the benchmarks successfully.

Written by the indexing model from the issue text.

Assessment

Tech stack
julia
Domain
ci-cd, performance
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
44/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.