# ArmoniK Analytics
Set of tools for analyzing workload execution 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_analytics)
[![Docs](https://readthedocs.org/projects/armonik-analytics/badge/?version=latest)](https://armonik-analytics.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_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.
```bash
git clone git@github.com:aneoconsulting/armonik_analytics.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)
Raw data
{
"_id": null,
"home_page": "",
"name": "armonik-analytics",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "",
"keywords": "ArmoniK,Analytics,task graph,HPC",
"author": "",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/f0/53/daa3e81dffdf7dfed66fe650aafca1bc7d56171a2350baec9ecc1ce67ff0/armonik_analytics-0.0.2.tar.gz",
"platform": null,
"description": "# ArmoniK Analytics\n\nSet of tools for analyzing workload execution on ArmoniK.\n\n\n[![License](https://img.shields.io/badge/license-Apache2-blue.svg)](LICENSE)\n[![Python Version](https://img.shields.io/badge/python-3.10%2B-blue.svg)](https://pypi.python.org/pypi/armonik_analytics)\n[![Docs](https://readthedocs.org/projects/armonik-analytics/badge/?version=latest)](https://armonik-analytics.readthedocs.io/en/latest/?version=latest)\n\n## Overview\n\nTODO\n\n## Features\n\nTODO\n\n## Installation\n\n### Prerequisites\n\n- Python 3.10\n- pip (Python package installer)\n\n### Setting up a Virtual Environment\n\nIt's a good practice to use a virtual environment to isolate your project dependencies. Create a virtual environment using `venv`:\n\n```bash\npython3 -m venv .venv\n```\n\nActivate the virtual environment:\n\n* On Windows:\n\n```powershell\n.\\.venv\\Scripts\\activate\n```\n\n* On Unix or MacOS:\n\n```bash\nsource .venv/bin/activate\n```\n\n### Installing the project using pip\n\nOnce the virtual environment is activated, you can install the project using pip.\n\n```bash\npip install armonik_analytics\n```\n\nThis will install the project and its dependencies.\n\n### Installing the project from sources\n\nYou can also intall the project from sources by cloning the repository.\n\n```bash\ngit clone git@github.com:aneoconsulting/armonik_analytics.git\n```\n\nNavigate to the project directory and run:\n\n```bash\npip install .\n```\n\nFor development, you might want to install additional packages for testing, linting, etc. Install the development dependencies using:\n\n```bash\npip install -e .[dev,tests]\n```\n\n\n\n## Contributing\n\nContributions are always welcome!\n\nSee [CONTRIBUTING.md](CONTRIBUTING.md) for ways to get started.\n\n## License\n\n[Apache Software License 2.0](LICENSE)\n",
"bugtrack_url": null,
"license": "Apache Software License 2.0",
"summary": "Set of tools for analyzing workload execution on ArmoniK.",
"version": "0.0.2",
"project_urls": {
"Bug Tracker": "https://github.com/aneoconsulting/ArmoniK.Analytics/issues",
"Homepage": "https://github.com/aneoconsulting/ArmoniK.Analytics",
"repository": "https://github.com/aneoconsulting/ArmoniK.Analytics"
},
"split_keywords": [
"armonik",
"analytics",
"task graph",
"hpc"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "048819bf0f1ca2d08d14f289e6bdcde2b2eebcfa655ae0ecbe1009d757b84796",
"md5": "b340690597023414a7922a9db7179e36",
"sha256": "963d73d78c6ae09a526193597e5d008df4bafe8e6df0ce7fb5e652599b51caf7"
},
"downloads": -1,
"filename": "armonik_analytics-0.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b340690597023414a7922a9db7179e36",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 8819,
"upload_time": "2024-03-18T15:23:46",
"upload_time_iso_8601": "2024-03-18T15:23:46.064230Z",
"url": "https://files.pythonhosted.org/packages/04/88/19bf0f1ca2d08d14f289e6bdcde2b2eebcfa655ae0ecbe1009d757b84796/armonik_analytics-0.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f053daa3e81dffdf7dfed66fe650aafca1bc7d56171a2350baec9ecc1ce67ff0",
"md5": "0e8b573a50c7804444b4919fc3df0aba",
"sha256": "2ab8c75b3f4bdd12a47f76b85ec337b5bf6e107ee0619eba6559c8f4d40085b3"
},
"downloads": -1,
"filename": "armonik_analytics-0.0.2.tar.gz",
"has_sig": false,
"md5_digest": "0e8b573a50c7804444b4919fc3df0aba",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 15553,
"upload_time": "2024-03-18T15:23:49",
"upload_time_iso_8601": "2024-03-18T15:23:49.683528Z",
"url": "https://files.pythonhosted.org/packages/f0/53/daa3e81dffdf7dfed66fe650aafca1bc7d56171a2350baec9ecc1ce67ff0/armonik_analytics-0.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-18 15:23:49",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "aneoconsulting",
"github_project": "ArmoniK.Analytics",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "armonik-analytics"
}