Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/aneoconsulting/armonik.bench

Set of tools for benchmarking performance on ArmoniK.
https://github.com/aneoconsulting/armonik.bench

Last synced: about 1 month ago
JSON representation

Set of tools for benchmarking performance on ArmoniK.

Host: GitHub
URL: https://github.com/aneoconsulting/armonik.bench
Owner: aneoconsulting
License: other
Created: 2024-02-29T09:05:43.000Z (11 months ago)
Default Branch: main
Last Pushed: 2024-07-18T10:07:52.000Z (6 months ago)
Last Synced: 2024-07-19T13:12:26.605Z (6 months ago)
Language: Python
Size: 145 KB
Stars: 0
Watchers: 2
Forks: 0
Open Issues: 3
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE

Awesome Lists containing this project

README

# ArmoniK Bench

Set of tools for benchmarking performance on ArmoniK.

[![License](https://img.shields.io/badge/license-Apache2-blue.svg)](LICENSE)
[![Python Version](https://img.shields.io/badge/python-3.10%2B-blue.svg)](https://pypi.python.org/pypi/armonik_bench)
[![Docs](https://readthedocs.org/projects/armonik-bench/badge/?version=latest)](https://armonik-bench.readthedocs.io/en/latest/?version=latest)

## Overview

TODO

## Features

TODO

## Installation

### Prerequisites

- Python 3.10
- pip (Python package installer)

### Setting up a Virtual Environment

It's a good practice to use a virtual environment to isolate your project dependencies. Create a virtual environment using `venv`:

```bash
python3 -m venv .venv
```

Activate the virtual environment:

* On Windows:

```powershell
.\.venv\Scripts\activate
```

* On Unix or MacOS:

```bash
source .venv/bin/activate
```

### Installing the project using pip

Once the virtual environment is activated, you can install the project using pip.

```bash
pip install armonik_bench
```

This will install the project and its dependencies.

### Installing the project from sources

You can also intall the project from sources by cloning the repository.

```bash
git clone [email protected]:aneoconsulting/armonik_bench.git
```

Navigate to the project directory and run:

```bash
pip install .
```

For development, you might want to install additional packages for testing, linting, etc. Install the development dependencies using:

```bash
pip install -e .[dev,tests]
```

## Contributing

Contributions are always welcome!

See [CONTRIBUTING.md](CONTRIBUTING.md) for ways to get started.

## License

[Apache Software License 2.0](LICENSE)