benchmarktool

A tool to easier generate, run and evaluate benchmarks.

Structure

This repository is structured as follows:
./benchmarks/: example benchmarks
./docs/: documentation
./output/: default output folder for the examples
./programs/: place solver/tool executables here
./runscripts/: contains example run-scripts
./src/: Python source files
./templates/: contains example script templates

Installation

The setuptools package is required to run the commands below. We recommend the usage of conda, which already includes setuptools in its default python installation. Any python version newer than 3.10 is supported.

$ git clone https://github.com/potassco/benchmark-tool
$ cd benchmark-tool
$ conda create -n <env-name> python=3.10
$ conda activate <env-name>
$ pip install .

The documentation can be accessed here or build and hosted using:

$ pip install .[doc]
$ mkdocs serve

And afterwards accessed at http://localhost:8000/systems/benchmark-tool/.

Usage

You can check a successful installation by running

$ btool -h

For more information and examples check the documentation.

NOTE: This project is still in active development. If you encounter any bugs, have ideas for improvement or feature requests, please open an issue.