Metadata-Version: 2.5
Name: MATE-libraries
Version: 1.2.0
Summary: Libraries of MATE, the Modular Algorithmic Toolkit for Evolution: network library and standard operators library for MATE modules, analysis library for recorded runs
Project-URL: Homepage, https://gitlab.com/artificial_evolution/mate/mate
Project-URL: Issues, https://gitlab.com/artificial_evolution/mate/mate/-/issues
Author: Sébastien Billès
Author-email: Raphaël Candelier <raphael.candelier@sorbonne-universite.fr>
License-Expression: LGPL-3.0-or-later
License-File: COPYING
License-File: COPYING.LESSER
Keywords: artificial evolution,evolutionary computation,neural networks
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Science/Research
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Scientific/Engineering
Requires-Python: >=3.14
Requires-Dist: mate-contract<2,>=1.1
Provides-Extra: analysis
Requires-Dist: matplotlib>=3.9; extra == 'analysis'
Provides-Extra: opencl
Requires-Dist: pyopencl>=2024.1; extra == 'opencl'
Provides-Extra: replay
Requires-Dist: lib-anim>=1.0.14; extra == 'replay'
Description-Content-Type: text/markdown

# MATE-libraries

The libraries of [MATE](https://gitlab.com/artificial_evolution/mate/mate), the
Modular Algorithmic Toolkit for Evolution: the network library and the standard
operators library, which method and system modules may use, and the analysis
library, which reads recorded runs and draws them. It depends on `MATE-contract`
only.

The standard operators library (`MATE_libraries.operators`) gives a variation
operator per domain and the standard selections. The network library
(`MATE_libraries.networks`) compiles batches of `Network` organs and propagates
them on the CPU, with results that do not depend on the batch. Each of these two
libraries has its own `version`, recorded in every run whose modules import it.
The analysis library (`MATE_libraries.analysis`) plots the performance of a
workdir's runs, one run at a time beside the others, and replays the evaluation
of an individual frame by frame; its figures need the `analysis` extra, its
replay window the `replay` extra (lib-anim).

## Installation

Requires Python 3.14 or later.

```
pip install MATE-libraries
pip install "MATE-libraries[analysis]"     # with the figures of the analysis library
pip install "MATE-libraries[replay]"       # with its replay window
```

A module that uses it declares it as a dependency; the runtime does not need it.

## Authors and acknowledgment

Crafted with ❤️ by Raphaël Candelier and Sébastien Billès.

## License

This project is licensed under the terms of the GNU Lesser General Public
License v3.0 or later (`LGPL-3.0-or-later`).
