Skip to content

Latest commit

 

History

History
54 lines (34 loc) · 2.13 KB

README.md

File metadata and controls

54 lines (34 loc) · 2.13 KB

PkgBenchmark

Benchmarking tools for Julia packages

Codecov License: MIT

Introduction

PkgBenchmark provides an interface for Julia package developers to track performance changes of their packages.

The package contains the following features:

  • Running the benchmark suite at a specified commit, branch or tag. The path to the julia executable, the command line flags, and the environment variables can be customized.
  • Comparing performance of a package between different package commits, branches or tags.
  • Exporting results to markdown for benchmarks and comparisons, similar to how Nanosoldier reports results for the benchmarks on Base Julia.

Installation

The package is registered and can be installed with Pkg.add as

julia> Pkg.add("PkgBenchmark")

Documentation

  • STABLEmost recently tagged version of the documentation.
  • DEVmost recent development version of the documentation.

Project Status

The package is tested against Julia v1.0 and the latest v1.x on Linux, macOS, and Windows.

Contributing and Questions

Contributions are welcome, as are feature requests and suggestions. Please open an issue if you encounter any problems.