Refactor how well position numbers are calculate to be Fluent-trough compatible #65
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This prepares deprecation of the `Labware.positions` lookup dictionary by providing an alternative, model-specific way to get position numbers. These functions account for differences in how EVO vs. Fluent address well positions in troughs.
…etters This removes their dependency on `Labware.positions` which will be deprecated.
This lookup dictionary encoded a well numbering scheme which differs between Tecan EVO and Tecan Fluent liquid handlers. Users should use these functions instead: * `evotools.get_well_position` * `fluenttools.get_well_position`
Co-authored-by: bertramgeinitz <[email protected]>
bertramgeinitz
approved these changes
Apr 5, 2024
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This refactors how well position numbers are calculated and accessed, such that cross-compatibility between Tecan EVO and Tecan Fluent is maximized.
Problem
On the EVO, troughs have "virtual rows" that count into the Fortran-style well numbering.
On the Fluent, all wells in the same column are addressed by the column number.
Previously,
Labware(...).positionswas the lookup-dictionary encoding this information within robotools.However, the construction of
Trough(...)orLabware(...)is not specific to the EVO vs. Fluent, and such a dependency should not be introduced.Solution
New functions are introduced to facilitate Tecan model-specific calculation of well position numbers:
evotools.get_well_positionfluenttools.get_well_positionThe
aspirate/dispense/distributecommands inBaseWorklistis modified to use a new, private methodself._get_well_positioninstead ofLabware().positions.EvoWorklist/FluentWorklistwhich route the call to the aforementioned functions.._get_well_positionis not marked abstract because some otherBaseWorklistmethods remain usable even without instances of model-specific worklist.._get_well_positionraises an informativeTypeErrorinstructing the user to useEvoWorklist/FluentWorklistfor model-specific operations.Changes
BaseWorklisttests were moved, because they are in factEvoWorklist-specific.Labware.positionswas deprecated and emits aDeprecationWarningwhen used.Trough(..., virtual_rows=...)will not be relevant for operations inFluentWorklistmoving forward.