The TTC 2019 Live Case: BibTeX to DocBook

Case description

The docs/case directory contains the case description.

Prerequisites

• 64-bit operating system
• Python 3.3 or higher
• R

Solution Prerequisites

• NMF: You need to install .NET Core 2.0

Add your prerequisites here!

Using the framework

The scripts directory contains the run.py script. At a first glance, invoke it without any arguments so that the solution will be built, benchmarked, running times visualized and the results compared to the reference solution's. One might fine tune the script for the following purposes:

• run.py -b -- builds the projects
• run.py -b -s -- builds the projects without testing
• run.py -g -- generates the instance models
• run.py -m -- run the benchmark without building
• run.py -v -- visualizes the results of the latest benchmark
• run.py -e -- compare results to the reference output. The benchmark shall already been executed using -m.
• run.py -m -e -- run benchmark without building, then extract and compare results to the reference output
• run.py -t -- build the project and run tests (usually unit tests as defined for the given solution)

The config directory contains the configuration for the scripts:

• config.json -- configuration for the model generation and the benchmark
  • Note: the timeout as set in the benchmark configuration (default: 6000 seconds) applies to the gross cumulative runtime of the tool for a given changeset and update sequences. This also includes e.g. Initialization time which is not required by the benchmark framework to be measured. Timeout is only applied to the solutions' run phase (see -m for run.py), so it is not applied to e.g. the build phase (see -b for run.py).
• reporting.json -- configuration for the visualization

Running the benchmark

The script runs the benchmark for the given number of runs, for the specified tools and change sequences.

The benchmark results are stored in a CSV file. The header for the CSV file is stored in the output/header.csv file.

Reporting and visualization

Make sure you read the README.md file in the reporting directory and install all the requirements for R.

Implementing the benchmark for a new tool

To implement a tool, you need to create a new directory in the solutions directory and give it a suitable name.