Metadata-Version: 2.1
Name: mapof-elections
Version: 0.1.0b4
Summary: Map of Elections
Author-email: Stanislaw Szufa <s.szufa@gmail.com>, Niclas Boehmer <niclas.boehmer@tu-berlin.de>, Piotr Faliszewski <faliszew@agh.edu.pl>, Lukasz Janeczko <lukij1997@gmail.com>, Andrzej Kaczmarczyk <andrzej.kaczmarczyk@agh.edu.pl>, Tomasz Was <tomasz.t.was@gmail.com>
License: Copyright (c) 2018-2024 Stanislaw Szufa, Andrzej Kaczmarczyk, and others.
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Requires-Dist: mapof>=0.0.2a4
Requires-Dist: tqdm==4.66.5
Requires-Dist: prefsampling==0.1.15
Provides-Extra: extras
Requires-Dist: abcvoting~=2.0.0b0; extra == "extras"
Requires-Dist: pulp~=2.5.1; extra == "extras"
Requires-Dist: permanent; extra == "extras"

[![Tests](https://github.com/science-for-democracy/mapof-elections/actions/workflows/python-tests.yml/badge.svg?branch=main)](https://github.com/science-for-democracy/mapof-elections/actions/workflows/python-tests.yml)
[![codecov](https://codecov.io/github/science-for-democracy/mapof-elections/graph/badge.svg?token=EDMLWNYCTP)](https://codecov.io/github/science-for-democracy/mapof-elections)


# Mapof-elections
This pacakge is a plugin for [Mapof](https://pypi.org/project/mapof/) extending
it with capabilities of drawing maps of various election intances.

For the most recent version of Mapof, visit its [git
repo](https://pypi.org/project/mapof/).

> [!WARNING!] This library contains C++ extensions. Installing it without
> any package manager that uses the PyPi repository requires compiling the C++
> extension from sources. It might be a bit cumbersome as is far beyond the
> scope of this small manual.

# Installation
For a simple installation, type
`pip install mapof-elections`
in the console.

For more complicated variants of installation, refer to the readme of mapel
[here](https://github.com/science-for-democracy/mapof).

## Extra dependencies

For the full functionality of the package, it is recommended to also install
extra dependencies executing `pip install mapof-elections[extras]`. The extra
dependencies contain 
```
pulp~=2.5.1
abcvoting~=2.0.0b0
permanent
```  
which unlock approval based committee rules (which require solving I(L)P
programs) and sampling matrices using a permanent-based approach.

# Acknowledgments

This project is part of the [PRAGMA project](https://home.agh.edu.pl/~pragma/)
which has received funding from the [European Research Council
(ERC)](https://home.agh.edu.pl/~pragma/) under the European Union’s Horizon 2020
research and innovation programme ([grant agreement No
101002854](https://erc.easme-web.eu/?p=101002854)).



