Metadata-Version: 2.4
Name: simalleles
Version: 0.9.0
Summary: Bibliothèque Python de simulation d'évolution d'allèles au fil des générations, avec interface web NiceGUI facultative (local, LAN ou site public).
Author-email: Asurix <contact@asurix.fr>
License-Expression: AGPL-3.0-only
Project-URL: Homepage, https://github.com/4surix
Project-URL: Repository, https://github.com/4surix/simalleles
Project-URL: Changelog, https://github.com/4surix/simalleles/blob/main/CHANGELOG.md
Project-URL: Demo, https://simalleles.asurix.fr
Keywords: genetics,simulation,biology,alleles,population,science,education
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Provides-Extra: ui
Requires-Dist: nicegui<4,>=3.19; extra == "ui"
Provides-Extra: dev
Requires-Dist: pytest>=8.0.0; extra == "dev"
Requires-Dist: pytest-asyncio>=0.23; extra == "dev"
Dynamic: license-file

# Simalleles

[![PyPI](https://img.shields.io/pypi/v/simalleles.svg)](https://pypi.org/project/simalleles/)
[![Python](https://img.shields.io/pypi/pyversions/simalleles.svg)](https://pypi.org/project/simalleles/)
[![Licence : AGPL-3.0](https://img.shields.io/badge/licence-AGPL--3.0-blue.svg)](https://github.com/4surix/simalleles/blob/main/LICENSE)
[![Tests](https://github.com/4surix/simalleles/actions/workflows/test.yml/badge.svg)](https://github.com/4surix/simalleles/actions/workflows/test.yml)

## Présentation

**SimAlleles** est un outil pédagogique et scientifique pour explorer, visualiser et modéliser les mécanismes de l'évolution. Il se décline en une interface web interactive et une bibliothèque Python légère, sans dépendance pour le moteur.

- **Aligné sur les programmes :** notions de Première, Terminale (spécialité SVT) et université.
- **Trois modes de service :** local sur un poste, LAN pour une salle de classe, ou site public derrière un reverse proxy HTTPS/WSS.
- **Moteur réutilisable :** la simulation s'importe dans un script ou un notebook, sans interface graphique.
- **Léger :** `pip install simalleles` installe le moteur seul, l'extra `[ui]` ajoute NiceGUI.

Démo publique : <https://simalleles.asurix.fr>.

## Paramètres

| Paramètre | Défaut | Plage | Effet |
|---|---:|---|---|
| Nombre de générations | 10 | ≥ 1 | Nombre de transitions simulées ; la sortie contient `n + 1` générations (0 à n). |
| Nombre de populations | 1 | ≥ 1 | Populations indépendantes, nommées `P1`, `P2`, etc. |
| Individus par population | 1000 | ≥ 1 | Effectif **initial** de chaque population. |
| Taux de reproduction | 1.00 | > 0 | Nombre d'enfants visés par individu et par génération. `1` maintient l'effectif, `> 1` le fait croître, `< 1` le réduit. |
| Inceste (%) | 0 | 0–100 | Probabilité de chercher le second parent dans la famille (parents, fratrie). |
| Migration (%) | 0 | 0–100 | Probabilité qu'un individu change de population. Sans effet avec une seule population. |
| Mutation (%) | 0 | 0–100 | Probabilité qu'un individu mute d'un seul allèle (`A` ↔ `a`). |
| Poids allèle A | 1.00 | > 0 | Poids de transmission de `A` lors du tirage des gamètes. |
| Poids allèle a | 1.00 | > 0 | Poids de transmission de `a` lors du tirage des gamètes. |
| Croisements A/A, A/a, a/a | cochés | booléens | Influencent la construction de la génération initiale. |
| Couleurs du graphique | activé | booléen | Traits colorés ou blancs avec des marqueurs distincts. |
| Axe Y 0–100 | activé | booléen | Fixe l'axe vertical entre 0 et 100 %. |

Les pourcentages sont des probabilités par individu et par génération. La mutation n'affecte qu'un seul des deux allèles. La graine (`seed`) n'est pas exposée dans l'interface ; elle est disponible dans l'API moteur pour rendre une démonstration reproductible.

## Installation

```bash
pip install simalleles          # moteur seul (aucune dépendance)
pip install "simalleles[ui]"    # avec l'interface web NiceGUI
```

> Prérequis : Python 3.10 ou plus récent.

## Démarrage rapide

Le moteur peut être utilisé sans serveur ni navigateur :

```python
from simalleles import Simulation, SimulationConfig

config = SimulationConfig(
    nbr_generations=30,
    nbr_populations=2,
    nbr_individus=100,
    taux=1.0,
    inceste=0,
    migration=10,
    mutation=1,
    weight_A=1.0,
    weight_a=1.0,
    seed=42,              # optionnel : rend la simulation reproductible
)

result = Simulation(config).run()

for name, history in result.items():
    last = history[-1]
    print(name, last["generation"], last["pourcentages"])
```

`result` est un dictionnaire `population -> liste de générations`. Chaque génération contient `generation`, les comptes `a_a`, `A_A`, `a_A`, `A_a` et le tuple `pourcentages` au format `(a/a, A/A, hétérozygotes)`. La génération `0` est la génération initiale ; `nbr_generations=30` produit donc 31 lignes.

La graine rend une exécution reproductible en pratique, mais aucune garantie bit-à-bit n'est fournie entre versions ou environnements. Les résultats restent stochastiques : une différence entre deux exécutions n'est pas nécessairement imputable à un paramètre.

## Lancement

```bash
simalleles                      # script installé : serveur sur 127.0.0.1:8080 + navigateur
python -m simalleles            # équivalent
python -m simalleles.web        # équivalent
```

Options utiles :

| Option | Effet |
|---|---|
| `--host` | Adresse d'écoute (défaut `127.0.0.1`, forcée à `0.0.0.0` en LAN/site). |
| `--port` | Port d'écoute (défaut `8080`). |
| `--no-show` | Ne pas ouvrir automatiquement le navigateur. |
| `--reload` | Rechargement automatique au changement de code (développement uniquement). |
| `--lan` | Mode LAN : `0.0.0.0`, navigateur ouvert, URL du réseau local affichées. |
| `--site` | Mode site : `0.0.0.0`, navigateur et rechargement désactivés, secret obligatoire. |
| `--forwarded-allow-ips` | IP du reverse proxy autorisée à fournir `X-Forwarded-*` (défaut `127.0.0.1`). |

> _`--lan` et `--site` sont mutuellement exclusifs._

```bash
simalleles --host 127.0.0.1 --port 8080
simalleles --no-show
simalleles --reload
```

### Depuis le code source

```bash
pip install -e ".[ui]"
python -m simalleles.web
```

## Tests

```bash
pip install -e ".[ui,dev]"
python -m pytest tests/ -v
```

Les 22 tests couvrent le moteur, les modes local/LAN/site, la CLI, l'export CSV et l'isolation de deux clients. Les tests d'interface utilisent `nicegui.testing.user_plugin` (headless, sans navigateur).

## Code source et licence

Le code est disponible sur <https://github.com/4surix/simalleles> et distribué sous [GNU AGPL-3.0](https://github.com/4surix/simalleles/blob/main/LICENSE).
