Metadata-Version: 2.4
Name: vote_simulation
Version: 0.1.0
Summary: A framework to compare social choice rules
Project-URL: bugs, https://github.com/Damidas0/vote_simulation/issues
Project-URL: changelog, https://github.com/Damidas0/vote_simulation/blob/main/HISTORY.md
Project-URL: documentation, https://Damidas0.github.io/vote_simulation/
Project-URL: homepage, https://github.com/Damidas0/vote_simulation
Author-email: Ambre Laqueuvre <ambre.laqueuvre@gmail.com>
Maintainer-email: Ambre Laqueuvre <ambre.laqueuvre@gmail.com>
License: MIT
License-File: LICENSE
Classifier: Typing :: Typed
Requires-Python: <3.15,>=3.12
Requires-Dist: ipykernel>=7.3.0
Requires-Dist: ipywidgets>=8.1.8
Requires-Dist: matplotlib>=3.9.0
Requires-Dist: nashpy>=0.0.43
Requires-Dist: numpy>=2.0.0
Requires-Dist: pandas>=2.2.0
Requires-Dist: pyarrow>=23.0.1
Requires-Dist: rich
Requires-Dist: scikit-learn>=1.8.0
Requires-Dist: streamlit>=1.57.0
Requires-Dist: svvamp>=0.13.0
Requires-Dist: tomli-w>=1.2.0
Requires-Dist: tqdm>=4.67.3
Requires-Dist: typer
Provides-Extra: r
Requires-Dist: rpy2>=3.5.0; extra == 'r'
Description-Content-Type: text/markdown

# vote_simulation

![PyPI version](https://img.shields.io/pypi/v/vote_simulation.svg)

A framework to compare social choice rules

* Created by **[Ambre Laqueuvre](https://github.com/Ambraser)**
  * PyPI: https://pypi.org/user/ambraser/
* PyPI package: https://pypi.org/project/vote_simulation/
* Free software: MIT License

## Features

* TODO

## Documentation

Documentation is built with [Zensical](https://zensical.org/) and deployed to GitHub Pages.

* **Live site:** https://Ambraser.github.io/vote-simulation/
* **Preview locally:** `just docs-serve` (serves at http://localhost:8000)
* **Build:** `just docs-build`

API documentation is auto-generated from docstrings using [mkdocstrings](https://mkdocstrings.github.io/).

Docs deploy automatically on push to `main` via GitHub Actions. To enable this, go to your repo's Settings > Pages and set the source to **GitHub Actions**.

## Development

To set up for local development:

```bash
# Clone your fork
git clone git@github.com:your_username/vote_simulation.git
cd vote_simulation

# Install in editable mode with live updates
uv tool install --editable .
```

This installs the CLI globally but with live updates - any changes you make to the source code are immediately available when you run `vote_simulation`.

Run the Streamlit UI locally:

```bash
just ui
```

If port 8501 is already in use, the launcher now falls back to the first free port starting at 8501. You can still force a port explicitly:

```bash
just ui --server.port 8502
```

Run tests:

```bash
uv run pytest
```

Run quality checks (format, lint, type check, test):

```bash
just qa
```

## Author

vote_simulation was created in 2026 by Ambre Laqueuvre.

Built with [Cookiecutter](https://github.com/cookiecutter/cookiecutter) and the [audreyfeldroy/cookiecutter-pypackage](https://github.com/audreyfeldroy/cookiecutter-pypackage) project template.
