diff options
Diffstat (limited to 'readme.txt')
| -rw-r--r-- | readme.txt | 29 |
1 files changed, 28 insertions, 1 deletions
@@ -1,6 +1,5 @@ - To compile this program, the following dependencies are needed: ghc (of course) @@ -22,3 +21,31 @@ Aside from base, the cabal packages required to compile this program are: containers + +Compilation is done by 'make all'. Further instruction on how to use this +program can be obtained from the '--help' switch, once compiled. + + + +The required data files this program expects can be obtained from + + http://results.aec.gov.au/20499/Website/SenateDownloadsMenu-20499-Csv.htm + +Specifically, the files listed under 'Formal Preferences'. At the moment this +program can only handle AEC Senate data from 2016 or later. Processing of State +Legislative Council data and more general STV data is a goal of future versions. + + + +Note that the number of count logs this program outputs differs slightly from +the number that the AEC provides. This is because the AEC's program merges a +few more logs compared to this one, eg the initial count, and counts that +elect candidates. + + + +Finally, be aware that processing STV data takes a long time and a lot of +memory. If you want to be sure that progress is happening, either turn on +the '--verbose' switch or monitor the output log directory. + + |