pyRCV2/README.md

# pyRCV2

pyRCV2 is an application for counting various preferential voting elections.

pyRCV2 may be used in a number of different ways:

* as an online web application, no installation or special software required, at <https://yingtongli.me/rcv/>
* as a standalone Python command line application
* as a library within another Python application

## Features

pyRCV2 accepts data in the [BLT file format](http://www.dia.govt.nz/diawebsite.NSF/Files/meekm/%24file/meekm.pdf), and can count votes using:

* weighted inclusive Gregory STV (e.g. [Scottish STV](https://www.opavote.com/methods/scottish-stv-rules))
* unweighted inclusive Gregory STV (e.g. [Australian Senate STV](https://www.legislation.gov.au/Details/C2020C00400/Html/Text#_Toc59107700))
* exclusive Gregory STV (e.g. [PRSA 1977](https://www.prsa.org.au/rule1977.htm) and [ERS97](https://www.electoral-reform.org.uk/latest-news-and-research/publications/how-to-conduct-an-election-by-the-single-transferable-vote-3rd-edition/))
* [Wright STV](https://www.aph.gov.au/Parliamentary_Business/Committees/House_of_Representatives_Committees?url=em/elect07/subs/sub051.1.pdf)

pyRCV2 is highly customisable, including options for:

* different quotas and quota rules (e.g. exact Droop, Hare) or progressively reducing quota
* calculations using fixed-point arithmetic or exact rational numbers
* different tie breaking rules (backwards, random, manual) with auditable deterministic random number generation
* extensible API for other counting methods

## Online usage

After preparing the BLT file, head to <https://yingtongli.me/rcv/>. Select the BLT file, and click *Count*. pyRCV2 will count the election and display the results in a count sheet. See [here](https://yingtongli.me/blog/2020/12/24/pyrcv2.html) for more detailed instructions.

By clicking *Show advanced options*, you can customise the options used for the count. A detailed explanation of the various options can be found [here](https://yingtongli.me/git/pyRCV2/about/docs/options.md).

## Command line usage

pyRCV2 may also be invoked as a command line application. Run `python -m pyRCV2 --help` to view help.

For example, run `python -m pyRCV2 stv path/to/blt_file.blt --ties backwards --ties random --random-seed foobar`.
Add README.md and prepare for web release 2020-12-24 18:52:29 +11:00			`# pyRCV2`

			`pyRCV2 is an application for counting various preferential voting elections.`

			`pyRCV2 may be used in a number of different ways:`

			`* as an online web application, no installation or special software required, at <https://yingtongli.me/rcv/>`
			`* as a standalone Python command line application`
			`* as a library within another Python application`

			`## Features`

			`pyRCV2 accepts data in the [BLT file format](http://www.dia.govt.nz/diawebsite.NSF/Files/meekm/%24file/meekm.pdf), and can count votes using:`

			`* weighted inclusive Gregory STV (e.g. [Scottish STV](https://www.opavote.com/methods/scottish-stv-rules))`
Update documentation 2020-12-31 02:14:12 +11:00			`* unweighted inclusive Gregory STV (e.g. [Australian Senate STV](https://www.legislation.gov.au/Details/C2020C00400/Html/Text#_Toc59107700))`
Update documentation 2021-01-04 17:51:24 +11:00			`* exclusive Gregory STV (e.g. [PRSA 1977](https://www.prsa.org.au/rule1977.htm) and [ERS97](https://www.electoral-reform.org.uk/latest-news-and-research/publications/how-to-conduct-an-election-by-the-single-transferable-vote-3rd-edition/))`
Add README.md and prepare for web release 2020-12-24 18:52:29 +11:00			`* [Wright STV](https://www.aph.gov.au/Parliamentary_Business/Committees/House_of_Representatives_Committees?url=em/elect07/subs/sub051.1.pdf)`

			`pyRCV2 is highly customisable, including options for:`

			`* different quotas and quota rules (e.g. exact Droop, Hare) or progressively reducing quota`
			`* calculations using fixed-point arithmetic or exact rational numbers`
			`* different tie breaking rules (backwards, random, manual) with auditable deterministic random number generation`
			`* extensible API for other counting methods`
Files for deployment Update documentation Include own copy of BigRational, as including this from github.com seems to cause issues when hosted online 2020-12-24 20:23:55 +11:00
			`## Online usage`

			`After preparing the BLT file, head to <https://yingtongli.me/rcv/>. Select the BLT file, and click Count. pyRCV2 will count the election and display the results in a count sheet. See [here](https://yingtongli.me/blog/2020/12/24/pyrcv2.html) for more detailed instructions.`

			`By clicking Show advanced options, you can customise the options used for the count. A detailed explanation of the various options can be found [here](https://yingtongli.me/git/pyRCV2/about/docs/options.md).`

			`## Command line usage`

			pyRCV2 may also be invoked as a command line application. Run `python -m pyRCV2 --help` to view help.

			For example, run `python -m pyRCV2 stv path/to/blt_file.blt --ties backwards --ties random --random-seed foobar`.