Metadata-Version: 2.4
Name: phyelds-simulator
Version: 8.8.0
Summary: A discrete-event simulator, with live rendering, for phyelds programs
License: Apache-2.0
Author: Davide Domini
Author-email: davide.domini@unibo.it
Requires-Python: >=3.12,<3.14
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Provides-Extra: jupyter
Requires-Dist: ipython (>=8.10.0) ; extra == "jupyter"
Requires-Dist: matplotlib (>=3.10.1,<3.11.0)
Requires-Dist: pandas (>=2.2.3,<3.0.0)
Requires-Dist: phyelds (>=8.0.0,<9.0.0)
Requires-Dist: pydantic (==2.12.5)
Project-URL: Homepage, https://github.com/phyelds/phyelds
Project-URL: Repository, https://github.com/phyelds/phyelds
Description-Content-Type: text/markdown

# phyelds-simulator

A discrete-event simulator for [phyelds](https://pypi.org/project/phyelds/) programs,
with live rendering, animation export and data export.

## Installation

```bash
pip install phyelds-simulator                # simulator and a compatible phyelds
pip install "phyelds-simulator[jupyter]"     # live rendering inside Jupyter
```

## Usage

```python
from phyelds.calculus import aggregate, neighbors
from phyelds.simulator import Simulator
from phyelds.simulator.deployments import grid_generation
from phyelds.simulator.neighborhood import radius_neighborhood
from phyelds.simulator.runner import schedule_program_for_all
```

The import paths are those of phyelds 7, where the simulator was part of `phyelds`.
See the [documentation](https://phyelds.github.io/phyelds/simulator/).

