Metadata-Version: 2.3
Name: omnibenchmark
Version: 0.2.2
Summary: A tool for automated scientific benchmarking
Author: Almut Lütge
Author-email: almut.lue@gmail.com
Requires-Python: ~=3.12
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Provides-Extra: dev
Provides-Extra: s3
Provides-Extra: test
Requires-Dist: GitPython (>=3.1.0)
Requires-Dist: PyYAML
Requires-Dist: aiohttp (>=3.9.5)
Requires-Dist: async (>=0.6.2)
Requires-Dist: boto3 (>=1.34.102) ; extra == "s3"
Requires-Dist: click (>=8.1.7)
Requires-Dist: easybuild (>=5.0.0)
Requires-Dist: easybuild-easyblocks (>=5.0.0)
Requires-Dist: filelock (>=3.4.0)
Requires-Dist: humanfriendly
Requires-Dist: ipython ; extra == "dev"
Requires-Dist: isort ; extra == "dev"
Requires-Dist: matplotlib (==3.8.0)
Requires-Dist: minio (>=7.2.7) ; extra == "s3"
Requires-Dist: networkx (>=3.3)
Requires-Dist: omni-schema (>=0.0.6)
Requires-Dist: poetry ; extra == "dev"
Requires-Dist: pre-commit ; extra == "dev"
Requires-Dist: pydantic
Requires-Dist: pydot (>=3.0.2)
Requires-Dist: pyright ; extra == "dev"
Requires-Dist: pytest-cov (>=4.1.0) ; extra == "test"
Requires-Dist: pytest-split (>=0.9.0) ; extra == "test"
Requires-Dist: pytest-timeout ; extra == "test"
Requires-Dist: pytest-xdist (>=3.6.1) ; extra == "test"
Requires-Dist: python-dateutil (>=2.9.0.post0)
Requires-Dist: requests (>=2.31.0)
Requires-Dist: ruff ; extra == "dev"
Requires-Dist: snakedeploy (>=0.10.0)
Requires-Dist: snakemake (>=8.0)
Requires-Dist: snakemake-storage-plugin-s3 (>=0.2.12) ; extra == "s3"
Requires-Dist: spdx-license-list (>=3.19)
Requires-Dist: testcontainers (>=4.5.1) ; extra == "test"
Requires-Dist: tqdm (>=4.66.4)
Requires-Dist: typing-extensions ; extra == "dev"
Description-Content-Type: text/markdown

## omnibenchmark

<p align="center">
<a href="https://github.com/omnibenchmark/omnibenchmark/tree/refs/heads/main"><img alt="tests result" src="https://github.com/omnibenchmark/omnibenchmark/actions/workflows/tests.yml/badge.svg?branch=main"></a>
<a href="https://github.com/omnibenchmark/omnibenchmark"><img alt="Coverage Status" src="./reports/coverage.svg"></a>
<a href="https://github.com/omnibenchmark/omnibenchmark/blob/main/LICENSE"><img alt="License: Apache 2.0" src="https://img.shields.io/badge/License-Apache_2.0-blue.svg"></a>
</p>

[![Linter: Ruff](https://img.shields.io/badge/Linter-Ruff-brightgreen?style=flat-square)](https://github.com/astral-sh/ruff)


[Omnibenchmark](https://omnibenchmark.org), a continuous benchmarking tool.

## Install

Recent versions of omnibenchmark should be installable [from pypi](https://pypi.org/project/omnibenchmark/):

```
pip install omnibenchmark
```

Do note that if you plan to use `conda` as a software execution backend, you will want to use omnibenchmark from within a conda environment manager. At the time of this writing, we recommend miniforge. See [the tutorial](https://omnibenchmark.org/tutorial/) for more details.

### Releases

See [our tags](https://github.com/omnibenchmark/omnibenchmark/tags).


### User documentation

[Live documentation](https://docs.omnibenchmark.org/latest) is avilable for every published release and the main branch.

Documentation includes a [CLI reference](https://docs.omnibenchmark.org/latest/reference/).

### Configuration

Omnibenchmark uses a configuration file to store paths for Easybuild modules, dataset storage, and other settings. The configuration file is automatically created and managed by the system. See the [Configuration documentation](https://docs.omnibenchmark.org/latest/config/) for details.

## Developer notes

Check [CONTRIBUTING.md](https://github.com/omnibenchmark/omnibenchmark/blob/main/CONTRIBUTING.md).

## Acknowledgements

Omnibenchmark incorporates great FOSS components, including but not limited to: [snakemake](https://snakemake.readthedocs.io/en/stable/), [easybuild](https://easybuild.io/), [apptainer](https://apptainer.org/), [lmod](https://lmod.readthedocs.io/en/latest/) and [git](https://git-scm.com/). Thank you!

## Pre-prints

- [Omnibenchmark (alpha) for continuous and open benchmarking in bioinformatics](https://arxiv.org/abs/2409.17038) (2024)
- [Building a continuous benchmarking ecosystem in bioinformatics](https://arxiv.org/abs/2409.15472) (2024)

