Skip to content

Latest commit

 

History

History
87 lines (51 loc) · 1.7 KB

README.md

File metadata and controls

87 lines (51 loc) · 1.7 KB
Raw

ArmoniK Analytics

Set of tools for analyzing workload execution on ArmoniK.

License Python Version Docs

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:

python3 -m venv .venv

Activate the virtual environment:

  • On Windows:
.\.venv\Scripts\activate
  • On Unix or MacOS:
source .venv/bin/activate

Installing the project using pip

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

pip install armonik_analytics

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.

git clone [email protected]:aneoconsulting/armonik_analytics.git

Navigate to the project directory and run:

pip install .

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

pip install -e .[dev,tests]

Contributing

Contributions are always welcome!

See CONTRIBUTING.md for ways to get started.

License

Apache Software License 2.0