potassco-benchmark-tool 2.2.1__tar.gz

potassco_benchmark_tool-2.2.1/.envrc

@@ -0,0 +1,3 @@
+if [[ -e .venv/bin/activate ]]; then
+    source .venv/bin/activate
+fi

potassco_benchmark_tool-2.2.1/.github/workflows/deploy.yml

@@ -0,0 +1,48 @@
+name: deploy to pypi
+
+on:
+  workflow_dispatch:
+  push:
+    tags:
+      - 'v[0-9]+.[0-9]+.[0-9]+'
+
+jobs:
+  test:
+    uses: ./.github/workflows/test.yml
+
+  deploy:
+    name: deploy
+    needs: test
+    permissions:
+      id-token: write
+    environment: release
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+        with:
+          fetch-depth: 0
+
+      - uses: actions/setup-python@v6
+        with:
+          python-version: '3.10'
+
+      - name: install build dependencies
+        run: python3 -m pip install build
+
+      - name: build package
+        run: python3 -m build --sdist --wheel --outdir dist/
+
+      - name: upload package
+        uses: actions/upload-artifact@v4
+        with:
+          name: package
+          path: dist/
+      - name: publish package (pypi)
+        if: ${{ github.event_name == 'push' && startsWith(github.ref, 'refs/tags/v') }}
+        uses: pypa/gh-action-pypi-publish@release/v1
+
+      - name: publish package (test.pypi)
+        if: ${{ github.event_name == 'workflow_dispatch' }}
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          repository-url: "https://test.pypi.org/legacy/"

potassco_benchmark_tool-2.2.1/.github/workflows/doc.yml

@@ -0,0 +1,51 @@
+name: Deploy Documentation
+on:
+  workflow_dispatch:
+  push:
+    tags:
+      - 'v[0-9]+.[0-9]+.[0-9]+'
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Set up Python 3.10
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.10'
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install -e .[doc]
+      - name: Build the documentation
+        run: mkdocs build
+      - name: Setup Pages
+        id: pages
+        uses: actions/configure-pages@v5
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: "./site"
+  deploy:
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{steps.deployment.outputs.page_url}}
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

potassco_benchmark_tool-2.2.1/.github/workflows/test.yml

@@ -0,0 +1,37 @@
+name: Run CI Test
+
+on:
+  push:
+    branches: [main, master, wip]
+  pull_request:
+  workflow_call:
+
+env:
+  FORCE_COLOR: "3"
+
+jobs:
+  build:
+    name: test on ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest]
+
+    steps:
+    - uses: actions/checkout@v4
+    - uses: actions/setup-python@v5
+      with:
+        python-version: |
+            3.10
+            3.14
+    
+    - name: install requirements
+      run: python -m pip install nox pre-commit
+
+    - name: run pre-commit
+      if: ${{ matrix.os == 'ubuntu-latest' }}
+      run: pre-commit run --all --show-diff-on-failure
+
+    - name: run tests
+      run: nox

potassco_benchmark_tool-2.2.1/.gitignore

@@ -0,0 +1,45 @@
+benchmarks/*
+programs/*
+resultparsers/*
+runscripts/*
+templates/*
+/test.*
+
+# Editors
+.vscode/
+*~
+\#*\#
+.\#*
+
+# Mac/OSX
+.DS_Store
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+.pytest_cache/
+
+# pyenv
+.python-version
+.venv
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+*egg-info*
+
+# unclassified
+dist
+build
+.coverage
+_build
+_autosummary
+site

potassco_benchmark_tool-2.2.1/.pre-commit-config.yaml

@@ -0,0 +1,37 @@
+repos:
+  - repo: https://github.com/myint/autoflake
+    rev: v2.3.0
+    hooks:
+    - id: autoflake
+      args: ["--in-place",  "--imports=fillname", "--ignore-init-module-imports", "--remove-unused-variables"]
+      exclude: ^.github/
+
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.5.0
+    hooks:
+    - id: end-of-file-fixer
+    - id: trailing-whitespace
+      exclude: ^.github/
+      args:
+      - --markdown-linebreak-ext=md
+
+  - repo: https://github.com/pycqa/isort
+    rev: 5.13.2
+    hooks:
+      - id: isort
+        exclude: ^.github/
+
+  - repo: https://github.com/psf/black
+    rev: 24.2.0
+    hooks:
+    - id: black
+      exclude: ^.github/
+
+  - repo: https://github.com/executablebooks/mdformat
+    rev: 0.7.17
+    hooks:
+    - id: mdformat
+      args: ["--wrap", "79"]
+      exclude: ^docs/
+      additional_dependencies:
+      - mdformat-gfm

potassco_benchmark_tool-2.2.1/CONTRIBUTING.md

@@ -0,0 +1,26 @@
+# Contributing
+
+## How to get help or discuss possible contributions
+
+To avoid duplicating issues, please search our [issue tracker][issues] before
+filing a new issue.
+
+- Open an [issue][new_issue] describing your problem.
+
+## How to make a contribution
+
+- Fork the [benchmark-tool][project_url] repository and create a branch for
+  your changes.
+- Submit a pull request to the master branch with your changes.
+- Respond to feedback on your pull request.
+- If everything is fine your pull request is merged. 🥳
+
+## License
+
+When contributing to this project, you agree that you have authored 100% of the
+content, that you have the necessary rights to the content and that the content
+you contribute may be provided under the project license.
+
+[issues]: https://github.com/potassco/benchmark-tool/issues
+[new_issue]: https://github.com/potassco/benchmark-tool/issues/new
+[project_url]: https://github.com/potassco/benchmark-tool

potassco_benchmark_tool-2.2.1/LICENSE

@@ -0,0 +1,21 @@
+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.

potassco_benchmark_tool-2.2.1/PKG-INFO

@@ -0,0 +1,125 @@
+Metadata-Version: 2.4
+Name: potassco-benchmark-tool
+Version: 2.2.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: xlsxwriter
+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 benchmark tool can be installed with any Python version newer than 3.10
+using pip:
+
+```bash
+pip install potassco-benchmark-tool
+```
+
+To access the latest updates and fixes you can either use:
+
+```bash
+pip install git+https://github.com/potassco/benchmark-tool
+```
+
+Or alternatively build the tool yourself, which requires the `setuptools`
+package. We recommend using conda, which includes `setuptools` in its default
+Python installation. To build the tool manually run the following commands:
+
+```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 spreadsheet and more
+
+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.

potassco_benchmark_tool-2.2.1/README.md

@@ -0,0 +1,62 @@
+# benchmarktool
+
+A tool to easier generate, run and evaluate benchmarks.
+
+## Installation
+
+The benchmark tool can be installed with any Python version newer than 3.10
+using pip:
+
+```bash
+pip install potassco-benchmark-tool
+```
+
+To access the latest updates and fixes you can either use:
+
+```bash
+pip install git+https://github.com/potassco/benchmark-tool
+```
+
+Or alternatively build the tool yourself, which requires the `setuptools`
+package. We recommend using conda, which includes `setuptools` in its default
+Python installation. To build the tool manually run the following commands:
+
+```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 spreadsheet and more
+
+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.

potassco_benchmark_tool-2.2.1/docs/_custom/css/extra.css

@@ -0,0 +1,30 @@
+:root {
+    --md-primary-fg-color: #6495ED;
+}
+
+[data-md-color-scheme="slate"] .md-header,
+[data-md-color-scheme="slate"] .md-tabs {
+    --md-primary-fg-color: #253758;
+}
+
+.md-grid {
+    max-width: 1350px;
+}
+
+.md-header__title {
+    font-size: 1.2rem;
+    height: 2.5rem;
+    line-height: 2.5rem;
+    margin-left: 0 !important;
+}
+
+.md-header__button.md-logo {
+    /* margin-left: 30; */
+    padding-bottom: 0.8rem;
+}
+
+.md-header__button.md-logo img,
+.md-header__button.md-logo svg {
+    height: 1.5rem;
+    width: 1.5rem;
+}

potassco_benchmark_tool-2.2.1/docs/_custom/css/mkdoclingo.css

@@ -0,0 +1,49 @@
+code.doc-clingo-symbol-encoding::after {
+    content: "ASP";
+    color: var(--md-primary-fg-color);
+}
+
+
+code.doc-clingo-symbol-predicate::after {
+    content: "predicate";
+    color: #ca91bf
+}
+
+
+:root {
+    --md-admonition-icon--asp-doc: url('data:image/svg+xml;charset=utf-8,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13.59 7.41 9 12l4.59 4.6L15 15.18 11.82 12 15 8.82M19 3a2 2 0 0 1 2 2v14a2 2 0 0 1-2 2H5a2 2 0 0 1-2-2V5a2 2 0 0 1 2-2z"/></svg>');
+    --md-admonition-icon--asp-doc-ref: url('data:image/svg+xml;charset=utf-8,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M15 7h5.5L15 1.5zM8 0h8l6 6v12a2 2 0 0 1-2 2H8a2 2 0 0 1-2-2V2a2 2 0 0 1 2-2M4 4v18h16v2H4a2 2 0 0 1-2-2V4z"/></svg>')
+}
+
+.md-typeset .admonition.asp-doc,
+.md-typeset details.asp-doc {
+    border-color: var(--md-primary-fg-color);
+}
+
+.md-typeset .admonition.asp-doc-ref,
+.md-typeset details.asp-doc-ref {
+    border-color: #ca91bf;
+}
+
+.md-typeset .asp-doc>.admonition-title,
+.md-typeset .asp-doc>summary {
+    background-color: #1669B810;
+}
+
+.md-typeset .asp-doc-ref>.admonition-title,
+.md-typeset .asp-doc-ref>summary {
+    background-color: #ca91bf10;
+}
+
+.md-typeset .asp-doc>.admonition-title::before,
+.md-typeset .asp-doc>summary::before {
+    background-color: var(--md-primary-fg-color);
+    -webkit-mask-image: var(--md-admonition-icon--asp-doc);
+    mask-image: var(--md-admonition-icon--asp-doc);
+}
+
+.md-typeset .asp-doc-ref>summary::before {
+    background-color: #ca91bf;
+    -webkit-mask-image: var(--md-admonition-icon--asp-doc-ref);
+    mask-image: var(--md-admonition-icon--asp-doc-ref);
+}

potassco_benchmark_tool-2.2.1/docs/_custom/css/mkdocstrings.css

@@ -0,0 +1,50 @@
+code.doc-section-title {
+    font-weight: bold;
+}
+
+code.doc-symbol-parameter::after {
+    content: "P";
+}
+
+code.doc-symbol-attribute::after {
+    content: "A";
+}
+
+code.doc-symbol-function::after {
+    content: "F";
+}
+
+code.doc-symbol-method::after {
+    content: "M";
+}
+
+code.doc-symbol-class::after {
+    content: "C";
+}
+
+code.doc-symbol-module::after {
+    content: "M";
+}
+
+:root {
+    --doc-symbol-parameter-fg-color: #df50af;
+    --doc-symbol-attribute-fg-color: #0079ff;
+    --doc-symbol-function-fg-color: #00dfa2;
+    --doc-symbol-method-fg-color: #00dfa2;
+    --doc-symbol-class-fg-color: #d1b619;
+    --doc-symbol-module-fg-color: #ff0060;
+
+    --doc-symbol-parameter-bg-color: #df50af1a;
+    --doc-symbol-attribute-bg-color: #0079ff1a;
+    --doc-symbol-function-bg-color: #00dfa21a;
+    --doc-symbol-method-bg-color: #00dfa21a;
+    --doc-symbol-class-bg-color: #d1b6191a;
+    --doc-symbol-module-bg-color: #ff00601a;
+}
+
+
+.cssClass>rect {
+    fill: #ff0000;
+    stroke: #ffff00;
+    stroke-width: 4px;
+}

potassco_benchmark_tool-2.2.1/docs/_custom/javascripts/mathjax.js

@@ -0,0 +1,19 @@
+window.MathJax = {
+    tex: {
+        inlineMath: [["\\(", "\\)"]],
+        displayMath: [["\\[", "\\]"]],
+        processEscapes: true,
+        processEnvironments: true
+    },
+    options: {
+        ignoreHtmlClass: ".*|",
+        processHtmlClass: "arithmatex"
+    }
+};
+
+document$.subscribe(() => {
+    MathJax.startup.output.clearCache()
+    MathJax.typesetClear()
+    MathJax.texReset()
+    MathJax.typesetPromise()
+})