Metadata-Version: 2.4
Name: royalflush
Version: 0.4.1
Summary: Royal FLush is a Python framework specifically designed to facilitate the development, execution and analysis of multi-agent systems (MAS) federated learning (FL) experiments.
Author-email: Francisco Enguix <enguix.fco@gmail.com>
Maintainer-email: Francisco Enguix <enguix.fco@gmail.com>
License-Expression: MIT
Project-URL: Homepage, https://github.com/FranEnguix/royalflush
Project-URL: Documentation, https://royalflush.readthedocs.io
Project-URL: Source, https://github.com/FranEnguix/royalflush
Project-URL: Issues, https://github.com/FranEnguix/royalflush/issues
Project-URL: Changelog, https://github.com/FranEnguix/royalflush/blob/main/CHANGELOG.md
Keywords: royalflush,artificial intelligence,multi-agent systems,intelligent agents,federated learning,framework
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: spade==3.3.2
Requires-Dist: networkx==2.8
Requires-Dist: pyvis==0.3.2
Requires-Dist: torch==2.6.0
Requires-Dist: numpy==1.26.4
Requires-Dist: pandas==2.2.3
Requires-Dist: plotly==5.24.1
Requires-Dist: torchvision==0.21.0
Requires-Dist: click==8.1.7
Provides-Extra: dev
Requires-Dist: black==24.4.2; extra == "dev"
Requires-Dist: pytest==8.3.2; extra == "dev"
Requires-Dist: pytest-cov==5.0.0; extra == "dev"
Requires-Dist: pytest-asyncio==0.23.8; extra == "dev"
Requires-Dist: mypy; extra == "dev"
Requires-Dist: isort; extra == "dev"
Requires-Dist: bump-my-version; extra == "dev"
Requires-Dist: pre-commit; extra == "dev"
Requires-Dist: wheel==0.45.1; extra == "dev"
Requires-Dist: twine==6.1.1; extra == "dev"
Requires-Dist: setuptools==78.1.0; extra == "dev"
Requires-Dist: build==1.2.1; extra == "dev"
Requires-Dist: sphinx==7.1.2; extra == "dev"
Requires-Dist: sphinx-rtd-theme; extra == "dev"
Provides-Extra: test
Requires-Dist: coverage; extra == "test"
Dynamic: license-file

# Royal FLush
Royal FLush is a Python framework specifically designed to facilitate the development, execution and analysis of multi-agent systems (MAS) federated learning (FL) experiments.

## Installation

### CPU

To install **Royal FLush** for CPU-only run:

```bash
pip install royalflush
```


### GPU

To install **Royal FLush** with CUDA 12.6 in Windows, use the following command:

```bash
pip install royalflush --extra-index-url https://download.pytorch.org/whl/cu126
```

> **Incorrect installation may cause issues!** Ensure you use the correct CUDA version for PyTorch 2.6.0.
   If you are unsure, check your CUDA version and visit:
   [https://pytorch.org/get-started/locally/](https://pytorch.org/get-started/locally/)


### Quickstart

For a quickstart example, check out the documentation at [royalflush.readthedocs.io](https://royalflush.readthedocs.io).

## Features

* Documentation API at [Read the Docs](https://royalflush.readthedocs.io).
* PEP 8 style.
* Free software under the MIT license.
