Metadata-Version: 2.4
Name: potassco-benchmark-tool
Version: 2.1.1
Summary: A benchmark-tool for ASP based systems.
Author: Roland Kaminski, Tom Schmidt
License: MIT License
        
        Copyright (c) 2025 Potassco
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Homepage, https://potassco.org
Project-URL: Repository, https://github.com/potassco/benchmark-tool
Project-URL: Documentation, https://potassco.org/benchmark-tool/
Keywords: benchmarking,benchmarks,Potassco
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: lxml
Requires-Dist: pandas
Requires-Dist: odswriter
Requires-Dist: pyarrow
Requires-Dist: nbformat
Provides-Extra: format
Requires-Dist: black; extra == "format"
Requires-Dist: isort; extra == "format"
Requires-Dist: autoflake; extra == "format"
Provides-Extra: lint-pylint
Requires-Dist: pylint; extra == "lint-pylint"
Provides-Extra: typecheck
Requires-Dist: types-setuptools; extra == "typecheck"
Requires-Dist: mypy; extra == "typecheck"
Provides-Extra: test
Requires-Dist: coverage[toml]; extra == "test"
Provides-Extra: doc
Requires-Dist: mkdocs; extra == "doc"
Requires-Dist: mkdocs-material; extra == "doc"
Requires-Dist: mkdocstrings[python]; extra == "doc"
Provides-Extra: dev
Requires-Dist: benchmarktool[lint_pylint,test,typecheck]; extra == "dev"
Provides-Extra: plot
Requires-Dist: plotly; extra == "plot"
Requires-Dist: ipywidgets; extra == "plot"
Requires-Dist: anywidget; extra == "plot"
Requires-Dist: jupyter; extra == "plot"
Dynamic: license-file

# benchmarktool

A tool to easier generate, run and evaluate benchmarks.

## 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.

```bash
$ 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](https://potassco.org/benchmark-tool/)
or build and hosted using:

```bash
$ pip install .[doc]
$ mkdocs serve
```

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

## Usage

You can check a successful installation by running

```bash
$ btool -h
```

Supported subcommands in order of use:

- `init` Prepare the benchmark environment
- `gen` Generate scripts from runscript
- `run-dist` Run distributed jobs
- `verify` Check for runlim errors and re-run failed instances
- `eval` Collect results
- `conv` Convert results to ODS or other formats

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.
