potassco-benchmark-tool 2.1.1__py3-none-any.whl

benchmarktool/tools.py

@@ -0,0 +1,82 @@
+"""
+Created on Jan 15, 2010
+
+@author: Roland Kaminski
+"""
+
+import os
+import re
+import stat
+
+
+def mkdir_p(path: str) -> None:
+    """
+    Simulates `mkdir -p` functionality.
+
+    Attributes:
+        path (str): A string holding the path to create.
+    """
+    if not os.path.exists(path):
+        os.makedirs(path)
+
+
+def xml_to_seconds_time(str_rep: str) -> int:
+    """
+    Converts `[<D>d] [<H>h] [<M>m] [<S>s]` time format to seconds.
+
+    Attributes:
+        str_rep (str): String representation.
+    """
+    mult = {"d": 86400, "h": 3600, "m": 60, "s": 1, "so": 1}
+    m = re.fullmatch(
+        r"(?P<so>[0-9]+)|(?:(?P<d>[0-9]+)d)?\s*(?:(?P<h>[0-9]+)h)?\s*(?:(?P<m>[0-9]+)m)?\s*(?:(?P<s>[0-9]+)s)?", str_rep
+    )
+    accu = 0
+    if m is not None:
+        for key, val in m.groupdict().items():
+            if val is not None:
+                accu += int(val) * mult[key]
+    return accu
+
+
+def seconds_to_xml_time(int_rep: int) -> str:
+    """
+    Converts time in seconds to `[<D>d] [<H>h] [<M>m] [<S>s]` time format.
+
+    Attributes:
+        int_rep (int): Int representation.
+    """
+    s = int_rep % 60
+    int_rep //= 60
+    m = int_rep % 60
+    int_rep //= 60
+    h = int_rep % 24
+    d = int_rep // 24
+    return "{0:02}d {1:02}h {2:02}m {3:02}s".format(d, h, m, s)
+
+
+def seconds_to_slurm_time(int_rep: int) -> str:
+    """
+    Converts time in seconds to `DD-HH:MM:SS` time format.
+
+    Attributes:
+        int_rep (int): Int representation.
+    """
+    s = int_rep % 60
+    int_rep //= 60
+    m = int_rep % 60
+    int_rep //= 60
+    h = int_rep % 24
+    d = int_rep // 24
+    return "{0:02}-{1:02}:{2:02}:{3:02}".format(d, h, m, s)
+
+
+def set_executable(filename: str) -> None:
+    """
+    Set execution permissions for given file.
+
+    Attributes:
+        filename (str): A file
+    """
+    filestat = os.stat(filename)
+    os.chmod(filename, filestat[0] | stat.S_IXUSR)

potassco_benchmark_tool-2.1.1.dist-info/METADATA

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

potassco_benchmark_tool-2.1.1.dist-info/RECORD

@@ -0,0 +1,29 @@
+benchmarktool/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+benchmarktool/entry_points.py,sha256=acy_lXchHqDyHVhQKabo8rgI8OszJwtUN3Y7eKfwBFA,13884
+benchmarktool/tools.py,sha256=pvSvLpXmr6Q1KPP4hc5mGiz15J9Go-dm0t1ZHSDGFLQ,1886
+benchmarktool/init/programs/gcat.sh,sha256=QbEE0VpU2Ea3QQrRCrdRUkVxSNDghN7VhRE32QwAJME,379
+benchmarktool/init/runscripts/runscript-all.xml,sha256=uZEAO17wnoEAW4s89XvBaWRsha4MhjJCU_umJ3vrnSI,2126
+benchmarktool/init/runscripts/runscript-dist.xml,sha256=hBHlux2_vmhuSf0jcCAi-TBN-zcvNGbFfKBxPACFUB4,676
+benchmarktool/init/runscripts/runscript-example.xml,sha256=6ah7dEEYhVTj7e8PQxdJhwdGufogJUDDgDNC9RfOPTQ,889
+benchmarktool/init/runscripts/runscript-seq.xml,sha256=pRCeVaJHbxa6y8kcoKYSJBJkvfeEKpe4Sn5gv4UE_NU,833
+benchmarktool/init/templates/seq-generic-single.sh,sha256=UGcEN2GbtOW5svPD-xMw27dwd_q7BXZa5gl4gISEG-I,606
+benchmarktool/init/templates/seq-generic-zip.sh,sha256=mb5KDkHlpLjik9G9NWHlkPakdwjWk8MgUA21ys57SAs,378
+benchmarktool/init/templates/seq-generic.sh,sha256=HwHu1swEdP2bvExWt_CcwaYIxD8PWXIgDYyaXgngJgM,336
+benchmarktool/init/templates/single.dist,sha256=X86hhkddknqSdwzkHtYMt5fN0K-cuC4PIeVM79ZbwnI,574
+benchmarktool/result/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+benchmarktool/result/ipynb_gen.py,sha256=ti-DEUQkOo98Yxf5lk9zGcjGJ_QPAVvQ3wkfkeBg_AY,14783
+benchmarktool/result/ods_config.py,sha256=e86MbvDbB8CJh_deDf6LaEGOi_CKvspCfwJsnJm8CTk,2156
+benchmarktool/result/ods_gen.py,sha256=XJEIlnN29iqG35yu6QRoYaDDbnus9uwwrL5kOHhvxmc,29055
+benchmarktool/result/parser.py,sha256=AeM0KZlTMPL8csOIBG3JD5A4yzxoXcra1kom87NCeB8,6625
+benchmarktool/result/result.py,sha256=v-bz9a2lR6POVitZGT-O6NSiOYWL5fWUN-pZXzUdbFs,14302
+benchmarktool/resultparser/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+benchmarktool/resultparser/clasp.py,sha256=q5W4gbysI3QTgBnOQi5kW8QZo50z5atWjT9afQ6hiCA,3508
+benchmarktool/runscript/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+benchmarktool/runscript/parser.py,sha256=ciBDnDOH3CjwrRdbUpcVjAt1PxbXUDO76l599uoH6nY,19961
+benchmarktool/runscript/runscript.py,sha256=hFeTq6NJ1e0RabWJUPxi8se-aZiEjYl_zrBuY6NDuwQ,54352
+potassco_benchmark_tool-2.1.1.dist-info/licenses/LICENSE,sha256=eiYGM1U3OL1PkD5Leken0kocRuk_9Inhq6aiyfSWYYs,1065
+potassco_benchmark_tool-2.1.1.dist-info/METADATA,sha256=BaGNhNrmVuELJaXFFgvVNFMQoOmlLet1MQN12Cwqp2k,4000
+potassco_benchmark_tool-2.1.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+potassco_benchmark_tool-2.1.1.dist-info/entry_points.txt,sha256=pHyaCS16SLT-m0ZpybGtvg2PxI5TNKonBUH1DJyeKVY,58
+potassco_benchmark_tool-2.1.1.dist-info/top_level.txt,sha256=raOGCL-YmmJFALuaHUXcH4bFccgTAB7JVLPxFFqFL7Y,14
+potassco_benchmark_tool-2.1.1.dist-info/RECORD,,

potassco_benchmark_tool-2.1.1.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

potassco_benchmark_tool-2.1.1.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+btool = benchmarktool.entry_points:main

potassco_benchmark_tool-2.1.1.dist-info/licenses/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.1.1.dist-info/top_level.txt

@@ -0,0 +1 @@
+benchmarktool