Liquid Classes drafting for PAPI docs 2.22 #17111
Conversation
| .. _liquids: | ||
|
|
||
| ######## | ||
| Liquids |
There was a problem hiding this comment.
new liquids article, and new overall description of liquids. previously, any information about liquids (define and specifying which well they were in) was under "Labware."
| .. _labeling-liquids: | ||
|
|
||
| ************************* | ||
| Labeling Liquids in Wells |
There was a problem hiding this comment.
this section was previously in "Labware" and was written by Ed.
|
|
||
| Define a liquid class to automatically populate advanced settings in your protocol optimized for use with any of three liquid classes. | ||
|
|
||
| - **Aqueous liquids**, based on deionized water, and the system default. |
There was a problem hiding this comment.
potentially expand into a table below to describe major differences between liquid class definitions: speed, flow rate, etc.
Users will want to know what changes and advanced settings they are adding to their protocol. Review JSON definitions for this.
api/docs/v2/liquids.rst
Outdated
|
|
||
| def define_liquid_class(Viscous) | ||
|
|
||
| **TODO**: fill in code-block example when ``define_liquid_class`` is used. what do users see? |
There was a problem hiding this comment.
what kinds of arguments do users see returned for define_liquid_class? In the API proposal Sanniti suggested that liquid handling properties would be returned. Editing them isn't supported yet, but do users see them?
api/docs/v2/liquids.rst
Outdated
| **TODO**: fill in code-block example when ``define_liquid_class`` is used. what do users see? | ||
|
|
||
| To transfer liquids of a defined class, use ``transfer_liquid``, just as you would for any liquid transfer. Here, you'll only specify source and destination wells and transfer volume. The liquid class definition contains all the other required information. | ||
| **TODO**: fill in code-block example for transferring a viscous liquid; defined with that class |
There was a problem hiding this comment.
I think source, destination, volume, new_tip, and trash location are returned for transfer_liquid. Want to confirm.
Overview
First drafting of support for three defined liquid classes; NOT to be merged. Created a new article for liquids that will include previous liquids information and added liquid classes text.
Test Plan and Hands on Testing
Sandbox. Will continue committing and editing as I write.
Changelog
-new liquids article in PAPI docs (for all liquids information, including previous. liquid classes description is added for three defined classes, and can expand in this article as we develop editable liquid classes).
-moved "Labeling Liquids in Wells" from new_labware.rst to new liquids.rst article
Review requests
guidance filling in code blocks. what else do we need to document for users in this MVP release?
Risk assessment
low