Metadata-Version: 2.4
Name: eclypse
Version: 0.8.1
Summary: an Edge-CLoud pYthon Platform for Simulated runtime Environments
License: MIT
License-File: LICENSE
Author: Jacopo Massa
Author-email: jacopo.massa@di.unipi.it
Maintainer: Jacopo Massa
Maintainer-email: jacopo.massa@di.unipi.it
Requires-Python: >=3.11,<3.14
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Provides-Extra: remote
Provides-Extra: tboard
Requires-Dist: aiofiles (>=25.1.0,<26.0.0)
Requires-Dist: loguru (>=0.7.3,<0.8.0)
Requires-Dist: networkx (>=3.5,<4.0)
Requires-Dist: pandas (>=2.3.3,<3.0.0)
Requires-Dist: ray[default] (>=2.51.0,<3.0.0) ; extra == "remote"
Requires-Dist: tensorboardx (>=2.6.4,<3.0.0) ; extra == "tboard"
Project-URL: Homepage, https://github.com/eclypse-org/eclypse
Project-URL: Repository, https://github.com/eclypse-org/eclypse
Description-Content-Type: text/markdown

<p align="center">
<picture>
    <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/eclypse-org/eclypse/refs/heads/main/docs/_static/images/dark.png?"><img width=450 alt="eclypse-logo" src="https://raw.githubusercontent.com/eclypse-org/eclypse/refs/heads/main/docs/_static/images/light.png"/>
</picture>
</p>

![PyPI - Python Version](https://img.shields.io/pypi/pyversions/eclypse)
[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&)](https://github.com/pre-commit/pre-commit)

[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
[![Checked with mypy](http://www.mypy-lang.org/static/mypy_badge.svg)](http://mypy-lang.org/)
[![Checked with pylint](https://img.shields.io/badge/pylint-10/10-green)](https://pylint.pycqa.org/en/latest/)
[![Import sorted with isort](https://img.shields.io/badge/isort-checked-brightgreen)](https://pycqa.github.io/isort/)
[![Import cleaned with pycln](https://img.shields.io/badge/pycln-checked-brightgreen)](https://github.com/hadialqattan/pycln)
[![Code style: black](https://img.shields.io/badge/code%20style-black-black)](https://github.com/psf/black)
[![Doc style: docformatter](https://img.shields.io/badge/doc%20style-docformatter-black)](https://github.com/PyCQA/docformatter)

**ECLYPSE** (**E**dge-**CL**oud p**Y**thon **P**latform for **S**imulated runtime **E**nvironments) is the first simulation library entirely written in Python, for experimenting with deployment strategies in varying infrastructure conditions. It provides an interface to simulate deployments of service-based applications onto life-like infrastructures, without and with an actual application implementation to be deployed.

## Installation

To install ECLYPSE and all its dependencies, you can run the following commands:
```bash

pip install eclypse

```

**N.B.** We **strongly** suggest the installation of ECLYPSE in a virtual environment.

## Documentation

The documentation for ECLYPSE can be found [here](https://eclypse.readthedocs.io/en/latest/).

## Publication

ECLYPSE is described and assessed in:

> Jacopo Massa, Valerio De Caro, Stefano Forti, Patrizio Dazzi, Davide Bacciu, Antonio Brogi<br>
> [**ECLYPSE: a Python Framework for Simulation and Emulation of the Cloud-Edge Continuum**](https://arxiv.org/abs/2501.17126), <br>
> arXiv preprint arXiv:2501.17126, 2025.

If you want to cite ECLYPSE in your work, you can use the following BibTeX entry:
```bibtex
@misc{massa2025eclypse,
    title         = {{ECLYPSE: a Python Framework for Simulation and Emulation of the Cloud-Edge Continuum}},
    author        = {Jacopo Massa and Valerio De Caro and Stefano Forti and Patrizio Dazzi and Davide Bacciu and Antonio Brogi},
    year          = {2025},
    eprint        = {2501.17126},
    archivePrefix = {arXiv},
    primaryClass  = {cs.NI},
    url           = {https://arxiv.org/abs/2501.17126},
}
```

## Authors

- **Jacopo Massa**
    - Website: [https://pages.di.unipi.it/massa](https://pages.di.unipi.it/massa)
    - GitHub: [jacopo-massa](https://github.com/jacopo-massa)
- **Valerio De Caro**
    - Website: [https://vdecaro.github.io](https://vdecaro.github.io)
    - GitHub: [vdecaro](https://github.com/vdecaro)

## Contact Us
If you want to get in touch with us, [drop us an e-mail](mailto:jacopo.massa@di.unipi.it,valerio.decaro@di.unipi.it?subject=[ECLYPSE]%20Request%20for%20information)!

