Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Incorporating Democratic Party Primary RCV tabulation in to Tabulator #403

Closed
chughes297 opened this issue Feb 3, 2020 · 3 comments
Closed

Comments

@chughes297
Copy link
Collaborator

As mentioned on the call a few weeks ago, the Democratic parties in Wyoming, Kansas, and Alaska are planning on using the Universal Tabulator to determine the results of their RCV presidential primaries this year. Clear Ballot is providing the scanners for the election; I spoke with Don Deford, who works at Clear Ballot, last week about what they need from the tabulator to run the election. Right now it's possible to get very close to the 15% threshold required by the rules (electing six candidates in a bottoms up contest would get you very close with a 14.3% threshold; five candidates would, also, with a 16.67% threshold, but not precise enough if a candidate comes within .7% to 15%). So, the only missing feature from the Tabulator for the Primaries is the ability to set an arbitrary threshold.

As I mentioned, the Democratic Primaries use an arbitrary 15% threshold to award delegates. That is the threshold of election they'll use for the RCV contests too, paired with bottoms up RCV allocation. So the election will follow typical single-winner RCV rules, eliminating one candidate at a time (or batch eliminating candidates) and edistributing votes from those candidates until only candidates with 15%+ of the vote are left. I'm not certain of this but I believe that 15% is set based on the votes cast in the first round, and is not dynamic based on the number of valid votes in each round. (this isn't specified in the rules, unfortunately).

The Wyoming and Alaska primaries are scheduled for April 4, and Kansas is scheduled for May 2.

A few things i wanted to raise that need deciding:

  • How should this arbitrary threshold option present itself to the user? Only if they select bottoms up? By selecting something labeled Democratic Presidential Primary? That selective appearance is not a function we've used before, though. Seems best to limit the availability of arbitrary threshold so that people don't accidentally use it, which is why I'm raising it here
  • Some states award delegates at the statewide and congressional district levels - I wonder if it would be possible to take statewide CVRs that have the Congressional District noted as the precinct and run both statewide and precinct results (but treating precincts as individual contests, unlike current precinct counts in the Tabulator). happy to be shot down on this if it adds too much complexity to the tabulator.

Also attaching the delegate selection rules I've gotten so far. Hawaii, which won't be using the tabulator, hasn't yet sent me theirs. Kansas lays out their RCV rules on pages 3-5; Alaska on pages 6-7; and Wyoming on pages 8-9.
2020-Kansas-Delegate-Selection-Plan_122019.pdf
AK+DSP+12.20.19.pdf
WY Delegate Selection Plan Oct. 9.19.pdf

@tarheel
Copy link
Contributor

tarheel commented Feb 10, 2020

OK, I had to refresh my memory on what "bottoms-up" means. According to our tabulator config documentation, setting winnerElectionMode to multiSeatBottomsUp means: "instead of running a standard multi-seat contest with single transferable votes, just eliminate candidates until there are numWinners remaining, then stop (only valid when numberOfWinners > 1)." But this isn't quite what we want here. We actually don't want to specify the number of seats at all, since the number of "winners" is just however many candidates are still active once we've managed to eliminate everyone who's below the threshold. (Regarding the question about whether the denominator is based on the first round or the current round: how will we get a clear answer on that? Basing it on the first round would feel more consistent with our existing logic, which defines the winning threshold for a multi-seat contest using the first round active vote count.)

My initial thought is that we should instead define a new option for winnerElectionMode called multiSeatBottomsUpWithThreshold, and a new field multiSeatBottomsUpThresholdValue that can be set to any number greater than 0 and less than or equal to 100 (not sure if it's OK to allow integers only). So you would enable this mode by using those two fields, and you would leave numberOfWinners blank in this case. That's going to be a bit gnarly on my end because the code currently assumes that numberOfWinners is always specified, but I think I can figure out a reasonable solution.

Regarding your question about selectively showing the threshold field: I wouldn't worry about that in the UI. We already have numerous config fields that are only valid when used in combination with certain other settings. We handle this by validating the config when you save or run it. In this case, for example, we would raise an error if you tried to set the threshold value without selecting multiSeatBottomsUpWithThreshold.

Regarding your question about Congressional districts: my instinct is that this would be adding a lot of complexity to the code to support a very niche use case. Would it be reasonable instead to expect the administrators to produce a separate CVR file for each district, and just run the contest once for each of these files?

Do I need to read through the attached rules, or can I assume that you'll alert us to any further details that are relevant to our coding work?

@chughes297
Copy link
Collaborator Author

Sorry, should have made that clearer - yes instead of a calculated seat-based threshold it's an arbitrary percentage threshold in this case.

Sounds good on the new winner election mode and threshold value field.

Makes sense on Congressional districts. I think yes, we should expect them to create a CVR for each district and work with it that way. I'll make sure my contact at Clear Ballot knows that, and just ensure that it's a sufficient solution for them.

No need to read through the rules, just wanted to be sure to share.

@tarheel
Copy link
Contributor

tarheel commented Feb 24, 2020

Rob clarified to me that the denominator used to calculate the 15% threshold should be dynamic (based on active ballots in the current round).

@tarheel tarheel mentioned this issue Mar 22, 2020
@tarheel tarheel closed this as completed Mar 23, 2020
HEdingfield added a commit that referenced this issue May 24, 2020
### New features:
* Added support for converting Dominion JSON CVRs to generic .csv format (including precinct portions) (#404, #406, #407, #408, #415, #439)
* Added multiSeatBottomsUpPercentageThreshold option (#403)
* Added CLI option to convert Dominion CVR to generic .csv (#408)
* New GUI menu and conversion options (can now convert to CDF and convert Dominion to generic via the GUI) (#408, #421)
* Added Dominion Alaska CVR to sample_input folder

### Bug fixes:
* Batch elimination now works properly with singleSeatContinueUntilTwoCandidatesRemain (#396)
* In a multi-seat contest, if someone wins in the first round, we now automatically eliminate undeclared write-ins before we eliminate any other candidates; previously, we treated UWIs like a normal candidate, which meant we potentially eliminated other candidates with lower tallies first (#397)
* If UWI exceeds the winning threshold in the initial count, we no longer mistakenly elect this candidate (#398)

### Backend updates:
* Updated dependencies to latest version: JDK, JavaFX, Checkstyle google_checks.xml, Checkstyle plugin, org.openjfx.javafxplugin, org.beryx.jlink, org.apache.commons:commons-csv, org.apache.poi:poi-ooxml, com.fasterxml.jackson.core:jackson-*
* Added special code to test configs to obviate the need to update the version with each increment (#426)
* Updated tests and improved test coverage
* Copyright update (#414)
* Code cleanup
moldover pushed a commit that referenced this issue Aug 12, 2022
### New features:
* Added support for converting Dominion JSON CVRs to generic .csv format (including precinct portions) (#404, #406, #407, #408, #415, #439)
* Added multiSeatBottomsUpPercentageThreshold option (#403)
* Added CLI option to convert Dominion CVR to generic .csv (#408)
* New GUI menu and conversion options (can now convert to CDF and convert Dominion to generic via the GUI) (#408, #421)
* Added Dominion Alaska CVR to sample_input folder

### Bug fixes:
* Batch elimination now works properly with singleSeatContinueUntilTwoCandidatesRemain (#396)
* In a multi-seat contest, if someone wins in the first round, we now automatically eliminate undeclared write-ins before we eliminate any other candidates; previously, we treated UWIs like a normal candidate, which meant we potentially eliminated other candidates with lower tallies first (#397)
* If UWI exceeds the winning threshold in the initial count, we no longer mistakenly elect this candidate (#398)

### Backend updates:
* Updated dependencies to latest version: JDK, JavaFX, Checkstyle google_checks.xml, Checkstyle plugin, org.openjfx.javafxplugin, org.beryx.jlink, org.apache.commons:commons-csv, org.apache.poi:poi-ooxml, com.fasterxml.jackson.core:jackson-*
* Added special code to test configs to obviate the need to update the version with each increment (#426)
* Updated tests and improved test coverage
* Copyright update (#414)
* Code cleanup
moldover added a commit that referenced this issue Aug 15, 2022
* Changed package from com.rcv to network.brightspots.rcv.

* remove unused tests: fix for #197

* add tiebreak test #197

* Allows user to cancel during interactive tiebreaker (fixes #132); adds example config file for testing interactive tiebreaker with sequential multi-seat enabled; adds commented command in build.gradle for executing CLI arguments.

* add missing precinct test

* Reconciles branch with `develop`.

* Re-adds interactive tiebreaker sample input.

* Continues fixing recently broken tests.

* Reverts name back to "Universal RCV Tabulator".

* add new random seed config field

* updated tests

* incorporate new option into tabulation logic and add test case

* onlyOneWinnerPerRound -> allowOnlyOneWinnerPerRound

* update test case to include a tie-break

* update tests

* address comments

* tests

* add test case

* update one test for each winnerElectionMode option

* updating tests

* fix tests

* fix minor output bug and add test case for previousRoundCountsThenRandom tie-break option

* fix minor issue with transfer tallies

* update test configs

* update a ton of JSON files!

* fix bad source path

* Increment version from 0.1.0 to 0.1.1. (#373)

* Increment version from 0.1.1 to 0.1.2

* Increment version from 0.1.2 to 1.0.0 (#384)

* v1.0.0

* Increment version from 1.0.0 to 1.0.1 (#389)

* Fix broken tests (#393)

* Increments version from "1.0.1" to "1.0.1_20200320_internal" (#423)

* Adds multiSeatBottomsUpPercentageThreshold (#428)

* Tests for Dominion CSV conversion routine (#429)

* test for Dominion csv conversion routine #415

* 2 more tests for cvr conversion

* updates for Dominion conversion tests: PR #425

* fix for PR #425

Co-authored-by: jonmoldover <jonmoldover@gmail.com>

* Adds AUTOMATED_TEST_VERSION code so tests can remain stable as app version updates (fixes #426). (#435)

* Fixes Dominion conversion output filenames and path (#436)

* Dominion conversion output files now output to same directory as input files and include timestamp in filename (#408).

* Updates Dominion tests to account for new filename schema; Dominion test files are now cleaned up automatically; fixes bug with fileCompare not closing readers.

* All delete operations in `TabulatorTests` now handle exceptions with useful error messages if they fail.

* read and write precinct portion and precinct (#433)

* read and write precinct portion + precinct

* edits for precinct portion PR#433

* Update src/main/java/network/brightspots/rcv/DominionCvrReader.java

Co-Authored-By: HEdingfield <HEdingfield@users.noreply.github.com>

* Update src/main/java/network/brightspots/rcv/DominionCvrReader.java

Co-Authored-By: HEdingfield <HEdingfield@users.noreply.github.com>

Co-authored-by: HEdingfield <HEdingfield@users.noreply.github.com>

* UWI test (#440)

* add UWI test files

* add an additional test to validate my fix of #397

* use a better name for the first test

* make batch elimination work properly with singleSeatContinueUntilTwoCandidatesRemain (#441)

* make batch elimination work properly with singleSeatContinueUntilTwoCandidatesRemain

* cleaned up wording

* v1.1.0 (#454)

### New features:
* Added support for converting Dominion JSON CVRs to generic .csv format (including precinct portions) (#404, #406, #407, #408, #415, #439)
* Added multiSeatBottomsUpPercentageThreshold option (#403)
* Added CLI option to convert Dominion CVR to generic .csv (#408)
* New GUI menu and conversion options (can now convert to CDF and convert Dominion to generic via the GUI) (#408, #421)
* Added Dominion Alaska CVR to sample_input folder

### Bug fixes:
* Batch elimination now works properly with singleSeatContinueUntilTwoCandidatesRemain (#396)
* In a multi-seat contest, if someone wins in the first round, we now automatically eliminate undeclared write-ins before we eliminate any other candidates; previously, we treated UWIs like a normal candidate, which meant we potentially eliminated other candidates with lower tallies first (#397)
* If UWI exceeds the winning threshold in the initial count, we no longer mistakenly elect this candidate (#398)

### Backend updates:
* Updated dependencies to latest version: JDK, JavaFX, Checkstyle google_checks.xml, Checkstyle plugin, org.openjfx.javafxplugin, org.beryx.jlink, org.apache.commons:commons-csv, org.apache.poi:poi-ooxml, com.fasterxml.jackson.core:jackson-*
* Added special code to test configs to obviate the need to update the version with each increment (#426)
* Updated tests and improved test coverage
* Copyright update (#414)
* Code cleanup

* Hart (#458)

* add contest id to config

* add xml parsing module

* First cut at Hart CVR reader + test assets.

* cleanup paths and add expected results

* add full cvr data

* refactor contestId from Integer to String

* add school board test

* fix xml parsing

* logging

* re-add accidentally removed import

* cleanup for PR#548

* updates for PR #458

* updates for PR #458

* test other file reading options

* more cleanup for PR #458

* more cleanup for PR #458

* Fixes tests not working in Windows due to mangled UTF-8 BOM marker.

* Handles potential NPE if chosen directory contains no files.

Co-authored-by: HEdingfield <hylton@groupagree.com>

* Update dependencies (#459)

* Updates to latest version:
    * Gradle 6.5.1
    * JDK 14.0.1
    * JavaFX 14.0.1
    * Checkstyle google_checks.xml 8.34
    * Checkstyle plugin 8.34
    * org.openjfx.javafxplugin 0.0.9
    * org.beryx.jlink 2.20.0
    * com.fasterxml.jackson.core:jackson-* 2.11.1
    * org.junit.jupiter.junit-jupiter-* 5.6.2
* Gets tests working with Gradle 6.5.1 (fixes #283)
* Updates `APP_VERSION` to temporary value 1.2.0_alpha
* Addresses Checkstyle warnings
* Fixes versions in Hart tests

* make contestId a real config field (#463)

* make contestId a real config field

* update .txt

* Providers dropdown (#462)

* Changes "Provider" field for CVR source to be required, bases it on an enum of valid values, and changes it to a ChoiceBox at the start of the "CVR Files" tab in the GUI  (progress on #460 and #461).
* Adds log message to help identify which CVR source validation errors pertain to.
* Gets rid of `SimpleObjectProperty` warnings during compile (fixes #280).

* Hart GUI (#466)

* Provider ComboBox now dynamically enables and disables fields and buttons when different providers are selected. (Progress on #461... actually progress on GUI phase 2!)
* Enables `DirectoryChooser` for Hart so it now functions through the GUI. (Fixes #460)
* Validation improved to fail if `firstVoteColumnIndex`, `firstVoteRowIndex`, `idColumnIndex`, `precinctColumnIndex` are defined for CVRs from non-ES&S providers.
* Removes superfluous logging.

* direct Dominion tabulation (#470)

* direct Dominion tabulation

* enable specifying a Dominion CVR source path in the UI

* output generic CSV and add test coverage

* remove extra log line

* filter out CVRs from other contests during the loading

* Changes `contestId` so it's specified on a per-CVR basis (fixes #456) (#474)

* First cut at Clear Ballot rcv reader (#475)

* First cut at Clear Ballot rcv reader
Add Kansas Dem Primary regression test
Add Clear Ballot reference files
#400

* updates for PR #475

* updates for PR #475

* updates for PR #475

* Enable Clear Ballot tabulation in GUI (progress on #400) (#480)

* GUI redesign phase 1 (#492)

* Splits Output tab into new Contest Info and Output tabs.
* Redesigns GUI CVR Files tab, adds Clear button, and changes Add button so it only clears the file path to make it easier to manually enter multiple sources that share fields.
* Improves visual presentation of Candidate tab; adds Clear button and adds checkBoxCandidateExcluded when adding a candidate.
* Reorganizes presentation of rules in "Winning Rules" and "Voter Error Rules" tabs.
* Winner Election Mode and Tiebreak Mode now start undefined with all relevant fields disabled; choosing specific modes enables applicable fields.
* Changes Winner Election Modes and Tiebreak Modes to be more user-friendly, including necessary migration logic to update older config files.
* Adds `continueUntilTwoCandidatesRemain` boolean (fixes #481).
* Expands footprint of GUI window to 1200x1000.
* Implements bordered boxes.

* remove Dominion conversion feature (#487)

* update test files

* remove conversion feature from code

* update test configs

* remove unnecessary check

* allow overvote delimiter for ES&S source files (#503)

* test

* update winner election mode logic

* comments

* final comments

* Read and Tabulate Unisyn Xml Cdf (#504)

* plumbing for xml cdf reading

* add contestId to json and xml CDF parse logic
update unisyn cvr test to use the full (but still incorrect) cvr data.  This test is expected to fail.
add candidate parsing code to xml CDF parser

* dont parse Candidate data from CDF at runtime - this enforces the same constraints on validation as all other file types.  The un-used candidate parsing code is left in for implementing future helper functions which will automatically populate config files.

* Handle ContestSelections in XML correctly

* add NIST example 2 (seems to be correctly formed)

* fill out CDF XML class definitions needed for tabulation

* add some helpers

* cleanup pre-processing code

* add more class fields around contest selections
fix ranking parsing
add example Unisyn contests

* handle write-ins

* get first 2 Unisyn regression tests working :)

* fix first NIST CDF XML test

* cleanup test names

* parse GpUnit from CVRs

* remove un-used assets

* updates for PR #504

* updated data from Unisyn with GpUnit (precinct) parsing validated

* add more Unisyn regression tests
tests share a single cvr input file

* tabulate all elections - in practice we should not see more than one

* updates for PR #504

* updates for PR #504

* Sundry UX fixes (#509)

* Converts `overvoteRule` from a `ChoiceBox` to an array of `RadioButton`s; changes `overvoteRule` string display in config files and adds migration logic.
* Disables `decimalPlacesForVoteArithmetic` and `nonIntegerWinningThreshold` except when `winnerElectionMode` is "Multi-winner allow only one winner per round" or "Multi-winner allow multiple winners per round" (fixes #500).
* Adds suggested values for `overvoteLabel`, `undervoteLabel`, and ES&S column and row indices as requested by @chughes297 (overriding what was in the original GUI mock-ups).
* Clarifies language to address confusing UX in `passesBasicCvrSourceValidation()` for CVR-specific errors.

* Cdf Json Fixes (#506)

* plumbing for xml cdf reading

* add contestId to json and xml CDF parse logic
update unisyn cvr test to use the full (but still incorrect) cvr data.  This test is expected to fail.
add candidate parsing code to xml CDF parser

* dont parse Candidate data from CDF at runtime - this enforces the same constraints on validation as all other file types.  The un-used candidate parsing code is left in for implementing future helper functions which will automatically populate config files.

* Handle ContestSelections in XML correctly

* add NIST example 2 (seems to be correctly formed)

* fill out CDF XML class definitions needed for tabulation

* add some helpers

* cleanup pre-processing code

* add more class fields around contest selections
fix ranking parsing
add example Unisyn contests

* handle write-ins

* get first 2 Unisyn regression tests working :)

* fix first NIST CDF XML test

* cleanup test names

* parse GpUnit from CVRs

* remove un-used assets

* updates for PR #504

* updated data from Unisyn with GpUnit (precinct) parsing validated

* add more Unisyn regression tests
tests share a single cvr input file

* tabulate all elections - in practice we should not see more than one

* updates for PR #504

* better logging

* first cut at fixing JSON CDF reader:
- all static election objects are parsed at beginning of cvr processing
- during processing contest selections are linked to candidate objects
- candidates are stored in config - not pulled from CDF file
- fixed NIST test set 0 config and CDF json to match the NIST 1500-103 UML
- verified tabulation results are correct for Nist test set 0 test

* update ResultsWriter CVR generation code to create Candidate objects and link to them from ContestSelection objects.
verified updated NIST test 0 cvr output

* updates for PR #504

* fix typo

* update test asset with contest name

* better handling for cdf reader parse errors

* update all CDF json assets

* Updates to CDF parsing logic:
Candidate validation and CandidateId validation are done while parsing CVRs (not during static parsing)
xml parser throws unrecognizedCandidatesException (instead of just CVRParserException)
Add json getCvrContest helper
json parser logic upgrades:
 handle writeIns in both places
 check for rank in both places
 check for HasIndication
 check for IsAllocable
 synthesize cvrId

* cleanup for PR #506

* updates for PR #505

* Throw if undeclared write-in is found but label has not been defined.

* make some fields per-source instead of per-config (#517)

* create new class

* helpful errors in CLI; don't allow newer version in config than in app

* make fields per-source

* comments

* Jon's changes

* fix almost all tests

* fix Dominion tests

* update validation and documentation for 4 fields that moved to CVR level (#518)

* update validation and documentation for 4 fields that moved to CVR level

* Fixes broken tests and a couple of typos.

Co-authored-by: HEdingfield <hylton@groupagree.com>

* camelCase strings for enums in config files (#519)

* use camelCase for enum values in configs and update migration logic accordingly
* disable editing of CVR source rows in GUI table

* Final 1.2.0 polish (#526)

* Updates checkstyle from 8.34 to 8.36.2, and google_checks.xml.
* Creates and implements separate `checkstyle-suppressions.xml` file to suppress Checkstyle warnings that don't make sense for our project (fixes #489).
* Addresses relevant Checkstyle warnings (fixes #490).
* Addresses IntelliJ warnings.
* Pixel-pushing for Linux (get thicc, boi)
* Changes all logging to use new `fine()`, `info()`, `warning()`, and `severe()` methods.
* Gets rid of now-unused `onEditCommit` functions for the CVR Files and Candidates tables.
* Makes util classes `final`, with private constructors to prevent instantiation.
* Renames `TieBreakMode`, `tieBreakMode`, `TieBreak`, and `tieBreak` to `TiebreakMode`, `tiebreakMode`, `Tiebreak`, and `tiebreak`, respectively. This word has now lost all meaning.
* Removes unnecessary usages of `.toString()`.
* Standardizes exceptions as `exception` instead of `e` to comply with VVSG requirement on variable names (5.2.5 paragraph c) that only index loops are allowed to have single-character variable names.
* Fixes broken test.
* Minor fixes to hints.
* Get rid of the Devilish Double Spaces after periods.

* Minor cleanups (#527)

* fix README

* CDF JSON: throw if a CandidateObject can't be found during parsing.

* Cleanup CDF class (type) names as output from ResultsWriter.

* fix label

* Handle missing precinct data for older Dominion data sets #533 (#534)

* Handle missing precinct data for older Dominion data sets #533
* Add test data with missing precinct data for older Dominion data sets #533

* Fix for #536 - allow multiple CDF files (#537)

* Fix for #536 - allow multiple CDF files
Add regression test with multiple CDF files

* fix overvote delimiter logic and update test (#539)

* Fixes for bad merge between `master` and `develop`.

* Add README and LICENSE for split repo

* latest updates from develop

* update cdf output names for #584

* add dominion multi file tests

* add licence file #551

* remove test_data as submodule #612

* remove test_data submodule #612

* remove submodule reference from docs #612

Co-authored-by: HEdingfield <hylton+git@groupagree.com>
Co-authored-by: hedingfield <hylton@groupagree.com>
Co-authored-by: Louis Eisenberg <tarheel@gmail.com>
Co-authored-by: HEdingfield <HEdingfield@users.noreply.github.com>
Co-authored-by: Armin Samii <artoonie@gmail.com>
Co-authored-by: Armin Samii <armin.samii@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants