phyelds 4.3.0__tar.gz

phyelds-4.3.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2025 Aguzzi Gianluca, Domini Davide
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

phyelds-4.3.0/PKG-INFO

@@ -0,0 +1,187 @@
+Metadata-Version: 2.1
+Name: phyelds
+Version: 4.3.0
+Summary: A lightweight Python library to support aggregate computing!
+Home-page: https://github.com/phyelds/phyelds
+License: Apache-2.0
+Author: Davide Domini
+Author-email: davide.domini@unibo.it
+Requires-Python: >=3.12,<4.0
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Dist: ipython (>=7.34.0,<8.0.0)
+Requires-Dist: matplotlib (>=3.10.1,<3.11.0)
+Requires-Dist: pandas (>=2.2.3,<3.0.0)
+Requires-Dist: pre-commit (>=4.2.0,<5.0.0)
+Requires-Dist: pydantic (==2.12.5)
+Requires-Dist: vmas (>=1.5.2,<2.0.0)
+Requires-Dist: wrapt (>=1.17.2,<1.18.0)
+Project-URL: Changelog, https://github.com/phyelds/phyelds/blob/master/CHANGELOG.md
+Project-URL: Repository, https://github.com/phyelds/phyelds
+Description-Content-Type: text/markdown
+
+<div align="center">
+
+# Phyelds
+
+Lightweight, pythonic aggregate computing & field calculus toolkit for building, simulating, and experimenting with decentralized adaptive systems.
+
+[![PyPI version](https://img.shields.io/pypi/v/phyelds.svg)](https://pypi.org/project/phyelds/)
+[![Python versions](https://img.shields.io/pypi/pyversions/phyelds.svg)](https://pypi.org/project/phyelds/)
+[![License](https://img.shields.io/github/license/phyelds/phyelds.svg)](./LICENSE)
+[![Last commit](https://img.shields.io/github/last-commit/phyelds/phyelds.svg)](https://github.com/phyelds/phyelds)
+
+</div>
+
+---
+
+## Table of Contents
+
+- [Why phyelds?](#why-phyelds)
+- [Features](#features)
+- [Installation](#installation)
+- [Core Concepts](#core-concepts)
+  - [Local State (`remember`)](#1-local-state-remember)
+  - [Neighborhood Values (`neighbors`)](#2-neighborhood-values-neighbors)
+  - [Combine State + Neighborhood](#3-combine-state--neighborhood)
+- [Development](#development)
+- [Contributing](#contributing)
+- [License](#license)
+- [Running a Minimal Simulation](#running-a-minimal-simulation)
+
+---
+
+## Why phyelds?
+
+You write one program describing global behaviour; all devices run it, exchanging only neighbor information. The library stays minimal so you can read the code and experiment quickly.
+
+## Features
+
+* Core primitives: `@aggregate`, `remember`, `neighbors`.
+* Functional `Field` abstraction (arithmetic & iteration) for neighbor values.
+* Pluggable discrete‑event simulator for experiments.
+* Extra libraries (spreading, collection, gossip, leader election) built on the same core.
+
+## Installation
+
+```bash
+pip install phyelds        # from PyPI
+# or
+poetry add phyelds
+```
+
+From source:
+
+```bash
+git clone https://github.com/phyelds/phyelds.git
+cd phyelds
+pip install -e .
+```
+
+Requires Python 3.13+ (see `pyproject.toml`).
+
+## Core Concepts
+To build spatio‑temporal (global) programs in Phyelds you only need a few simple ideas: every device runs the same `@aggregate` function in discrete *rounds*,
+local persistent state is managed with `remember(...)`,
+and devices exchange values with neighbors to form `Field`s.
+The table below summarizes these core primitives and their intuition.
+
+| Primitive | What it does | Intuition |
+|-----------|--------------|-----------|
+| `@aggregate` | Marks a function executed each round on every device. | Single spec, many instances. |
+| `remember(init)` | Persistent local state across rounds. | Local variable that survives. |
+| `neighbors(value)` | Collects one value from each neighbor (and self) into a `Field`. | One communication hop. |
+| `Field` | Iterable mapping (id → value) with element‑wise ops. | Lightweight vector of neighbor data. |
+
+
+**Practical tips:**
+* Treat rounds as atomic: reading remember().value gives last round's state.
+* Keep aggregate functions deterministic and side‑effect free for easier reasoning and testing.
+* Start small: use remember + neighbors examples above to experiment before adding the simulator.
+
+In the next section we'll explore these core concepts in more detail with practical examples.
+
+### 1. Local State (`remember`)
+
+```python
+from phyelds.calculus import aggregate, remember
+
+@aggregate
+def counter():
+    # Starts at 0 the first round, then increments each subsequent round
+    update_counter, counter_value = remember(0)
+    update_counter(counter_value + 1)
+    return counter_value
+```
+**Idea:** `remember` gives you a mutable state cell; `.update_fn` rewrites it each round.
+
+### 2. Neighborhood Values (`neighbors`)
+
+```python
+from phyelds.calculus import aggregate, neighbors
+
+@aggregate
+def neighbor_sum():
+    # Every device advertises the constant 1; result = number of (neighbors + self)
+    nbr = neighbors(1)
+    return sum(nbr)
+```
+**Idea:** Calling `neighbors(v)` both sends `v` out and returns a `Field` of received values (including self), so summing counts devices in the local neighborhood plus self.
+
+### 3. Combine State + Neighborhood
+
+```python
+from phyelds.calculus import aggregate, remember_and_evolve, neighbors
+
+@aggregate
+def average_counter():
+    # Each node advertises the value 1; summing counts (neighbors + self)
+    c = remember_and_evolve(0, lambda x: x + 1)  # each device keeps its own counter
+    nbr_c = neighbors(c)                  # gather neighbor counters (and self)
+    # Simple average of all visible counters
+    return sum(nbr_c) / len(nbr_c.data)
+```
+**Idea:** Persist something locally, exchange it, compute a derived aggregate.
+
+That is the core. Everything more advanced (gradients, collection trees, leader election) is constructed from these.
+
+## Development
+
+```bash
+git clone https://github.com/phyelds/phyelds.git
+cd phyelds
+poetry install
+poetry run pytest -q
+```
+
+## Contributing
+
+1. Open an issue for non‑trivial changes.
+2. Keep PRs focused with tests.
+3. Run linters & tests before submitting.
+
+## License
+
+Apache License 2.0 – see [LICENSE](./LICENSE).
+
+---
+
+## Running a Minimal Simulation
+
+A runnable example is provided in `src/minimal_simulation.py`.
+
+Run it:
+
+```bash
+poetry run python src/minimal_simulation.py
+```
+
+It creates 5 nodes in a line, each advertising `1`, and prints how many devices each node sees (neighbors + itself). Interior nodes report 3; endpoints report 2.
+
+---
+
+Happy field building! ✨
+

phyelds-4.3.0/README.md

@@ -0,0 +1,161 @@
+<div align="center">
+
+# Phyelds
+
+Lightweight, pythonic aggregate computing & field calculus toolkit for building, simulating, and experimenting with decentralized adaptive systems.
+
+[![PyPI version](https://img.shields.io/pypi/v/phyelds.svg)](https://pypi.org/project/phyelds/)
+[![Python versions](https://img.shields.io/pypi/pyversions/phyelds.svg)](https://pypi.org/project/phyelds/)
+[![License](https://img.shields.io/github/license/phyelds/phyelds.svg)](./LICENSE)
+[![Last commit](https://img.shields.io/github/last-commit/phyelds/phyelds.svg)](https://github.com/phyelds/phyelds)
+
+</div>
+
+---
+
+## Table of Contents
+
+- [Why phyelds?](#why-phyelds)
+- [Features](#features)
+- [Installation](#installation)
+- [Core Concepts](#core-concepts)
+  - [Local State (`remember`)](#1-local-state-remember)
+  - [Neighborhood Values (`neighbors`)](#2-neighborhood-values-neighbors)
+  - [Combine State + Neighborhood](#3-combine-state--neighborhood)
+- [Development](#development)
+- [Contributing](#contributing)
+- [License](#license)
+- [Running a Minimal Simulation](#running-a-minimal-simulation)
+
+---
+
+## Why phyelds?
+
+You write one program describing global behaviour; all devices run it, exchanging only neighbor information. The library stays minimal so you can read the code and experiment quickly.
+
+## Features
+
+* Core primitives: `@aggregate`, `remember`, `neighbors`.
+* Functional `Field` abstraction (arithmetic & iteration) for neighbor values.
+* Pluggable discrete‑event simulator for experiments.
+* Extra libraries (spreading, collection, gossip, leader election) built on the same core.
+
+## Installation
+
+```bash
+pip install phyelds        # from PyPI
+# or
+poetry add phyelds
+```
+
+From source:
+
+```bash
+git clone https://github.com/phyelds/phyelds.git
+cd phyelds
+pip install -e .
+```
+
+Requires Python 3.13+ (see `pyproject.toml`).
+
+## Core Concepts
+To build spatio‑temporal (global) programs in Phyelds you only need a few simple ideas: every device runs the same `@aggregate` function in discrete *rounds*,
+local persistent state is managed with `remember(...)`,
+and devices exchange values with neighbors to form `Field`s.
+The table below summarizes these core primitives and their intuition.
+
+| Primitive | What it does | Intuition |
+|-----------|--------------|-----------|
+| `@aggregate` | Marks a function executed each round on every device. | Single spec, many instances. |
+| `remember(init)` | Persistent local state across rounds. | Local variable that survives. |
+| `neighbors(value)` | Collects one value from each neighbor (and self) into a `Field`. | One communication hop. |
+| `Field` | Iterable mapping (id → value) with element‑wise ops. | Lightweight vector of neighbor data. |
+
+
+**Practical tips:**
+* Treat rounds as atomic: reading remember().value gives last round's state.
+* Keep aggregate functions deterministic and side‑effect free for easier reasoning and testing.
+* Start small: use remember + neighbors examples above to experiment before adding the simulator.
+
+In the next section we'll explore these core concepts in more detail with practical examples.
+
+### 1. Local State (`remember`)
+
+```python
+from phyelds.calculus import aggregate, remember
+
+@aggregate
+def counter():
+    # Starts at 0 the first round, then increments each subsequent round
+    update_counter, counter_value = remember(0)
+    update_counter(counter_value + 1)
+    return counter_value
+```
+**Idea:** `remember` gives you a mutable state cell; `.update_fn` rewrites it each round.
+
+### 2. Neighborhood Values (`neighbors`)
+
+```python
+from phyelds.calculus import aggregate, neighbors
+
+@aggregate
+def neighbor_sum():
+    # Every device advertises the constant 1; result = number of (neighbors + self)
+    nbr = neighbors(1)
+    return sum(nbr)
+```
+**Idea:** Calling `neighbors(v)` both sends `v` out and returns a `Field` of received values (including self), so summing counts devices in the local neighborhood plus self.
+
+### 3. Combine State + Neighborhood
+
+```python
+from phyelds.calculus import aggregate, remember_and_evolve, neighbors
+
+@aggregate
+def average_counter():
+    # Each node advertises the value 1; summing counts (neighbors + self)
+    c = remember_and_evolve(0, lambda x: x + 1)  # each device keeps its own counter
+    nbr_c = neighbors(c)                  # gather neighbor counters (and self)
+    # Simple average of all visible counters
+    return sum(nbr_c) / len(nbr_c.data)
+```
+**Idea:** Persist something locally, exchange it, compute a derived aggregate.
+
+That is the core. Everything more advanced (gradients, collection trees, leader election) is constructed from these.
+
+## Development
+
+```bash
+git clone https://github.com/phyelds/phyelds.git
+cd phyelds
+poetry install
+poetry run pytest -q
+```
+
+## Contributing
+
+1. Open an issue for non‑trivial changes.
+2. Keep PRs focused with tests.
+3. Run linters & tests before submitting.
+
+## License
+
+Apache License 2.0 – see [LICENSE](./LICENSE).
+
+---
+
+## Running a Minimal Simulation
+
+A runnable example is provided in `src/minimal_simulation.py`.
+
+Run it:
+
+```bash
+poetry run python src/minimal_simulation.py
+```
+
+It creates 5 nodes in a line, each advertising `1`, and prints how many devices each node sees (neighbors + itself). Interior nodes report 3; endpoints report 2.
+
+---
+
+Happy field building! ✨

phyelds-4.3.0/pyproject.toml

@@ -0,0 +1,52 @@
+[tool.poetry]
+name = "phyelds"
+version = "4.3.0"
+description = "A lightweight Python library to support aggregate computing!"
+license = "Apache-2.0"
+authors = [
+  "Davide Domini <davide.domini@unibo.it>",
+  "Gianluca Aguzzi <gianluca.aguzzi@unibo.it>"
+]
+homepage = "https://github.com/phyelds/phyelds"
+repository = "https://github.com/phyelds/phyelds"
+
+readme = "README.md"
+
+include = [
+    "LICENSE",
+]
+
+packages = [
+    { include = "phyelds", from = "src" },
+]
+
+classifiers = [
+    "Operating System :: OS Independent",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+]
+
+[tool.poetry.urls]
+"Changelog" = "https://github.com/phyelds/phyelds/blob/master/CHANGELOG.md"
+
+[tool.pytest.ini_options]
+testpaths = ["src/tests"]
+
+[build-system]
+requires = ["poetry-core>=2.0.0,<3.0.0"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.poetry.dependencies]
+python = "^3.12"
+wrapt = ">=1.17.2,<1.18.0"
+matplotlib = ">=3.10.1,<3.11.0"
+pre-commit = "^4.2.0"
+pandas = "^2.2.3"
+vmas = "^1.5.2"
+pydantic = "2.12.5"
+ipython = "^7.34.0"
+[tool.poetry.group.dev.dependencies]
+pytest = "^8.0.0"
+pylint = "^3.0.0"
+pytest-cov = "^3.0.0"
+ruff = "^0.3.0"
+flake8 = "^7.0.0"

phyelds-4.3.0/src/phyelds/__init__.py

@@ -0,0 +1,17 @@
+"""
+phyelds: A Python library for aggregate computing system with a pythonic interface.
+
+This library provides a set of tools for building and running aggregate computing systems.
+
+A global engine is used to manage the state and message passing between different contexts.
+In order to use it, you should:
+1. Call `engine.setup(messages, id, state)` to initialize the engine with the current context.
+2. Call an aggregate script
+3. Call `engine.cooldown()` to reset the engine state and get the messages to send.
+4. Store the state for the next iteration.
+
+"""
+from contextvars import ContextVar
+from phyelds.abstractions import Engine
+
+engine: ContextVar[Engine] = ContextVar("engine")