Metadata-Version: 2.1
Name: evoke-signals
Version: 0.1.0
Summary: Signalling games in python
License: GPL-3.0-or-later
Author: Stephen Mann
Author-email: stephenfmann@gmail.com
Requires-Python: >3.8,<3.12
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Dist: matplotlib (>3.7.1)
Requires-Dist: numpy (>1.20)
Requires-Dist: pygambit (>16.1.0)
Requires-Dist: python-ternary (>1.0.0)
Requires-Dist: scipy (>=1.10.1,<2.0.0)
Requires-Dist: tqdm (>4.50.1)
Description-Content-Type: text/markdown

# Overview

evoke enables users to recreate signalling game simulations from the academic literature.

It comprises a library of methods from **evolutionary game theory** `evoke/src/` and an ever-growing collection of **user-friendly examples** `evoke/examples/`.

## Online tutorial

See the interactive tutorial on [Google Colab](https://colab.research.google.com/drive/1AwUCP05lpITAP7_EZD7loGv3unhnwvhM#forceEdit=true&sandboxMode=true).

## Installation

Install with pip: `pip install evoke_signals`.

## Basic usage

To create one of the example figures, simply import the relevant class and create an instance of it:

```
from evoke.examples.skyrms2010signals import Skyrms2010_1_1
fig1_1 = Skyrms2010_1_1()
```

![Example of Skyrms 2010 Figure 1.1](https://github.com/signalling-games-org/evoke/blob/main/docs/tutorials/figures/skyrms2010_1_1.png?raw=true)

Certain figures allow you to specify your own parameters:

```
from evoke.examples.skyrms2010signals import Skyrms2010_3_3
fig3_3 = Skyrms2010_3_3(iterations=1000)
````

![Example of Skyrms 2010 Figure 3.3](https://github.com/signalling-games-org/evoke/blob/main/docs/tutorials/figures/skyrms2010_3_3.png?raw=true)

See the `examples/` directory for a collection of available figures.

