build files for custom python protocol for beta testing of heater shaker

protoBuilds/heater-shaker-test/README.json

@@ -0,0 +1,32 @@
+{
+    "author": "Opentrons",
+    "categories": {
+        "Heater Shaker": [
+            "Heater Shaker Beta Test"
+        ]
+    },
+    "deck-setup": "\n\n\nSlot 1: Opentrons Heater Shaker Module with selected labware \nSlot 3: Source Labware (well plate or reservoir) \nSlot 6: Destination Labware (well plate or reservoir) \nSlot 11: Opentrons Tips\n",
+    "description": "This protocol performs beta-testing steps of the Opentrons Heater Shaker Module with user-determined parameters for selection of the target temperature of the heater shaker (37-95 degrees Celsius), the target shaking speed (recommended 200-2000 rpm although it is possible to go up to 3000 rpm), duration of time for shaking (minutes), n (dispense to every nth column of the heater shaker labware - to save run-time), the labware on the heater shaker (five options listed in the protocol parameters section of the python script), the source labware (a well plate or reservoir from the Opentrons Labware Library - see list in protocol parameters section of the python script), the destination labware (a well plate or reservoir from the Opentrons Labware Library - see list in protocol parameters section of the python script), the transfer volume, and the pipette to be used (any single- or multi-channel pipette). The beta-test protocol will open and close the heater shaker latch and report latch status to the log, set target temperature and proceed without waiting, report the current temperature to the log, report the selected target wells to the log, perform liquid transfers from the source labware to the heater shaker labware, wait to ensure the previously set temperature has been reached, start shaking and capture the start time, perform a pipette mix in the destination labware to demo a pipetting step NOT targeting the heater shaker but occurring during the timed shake, wait until the shake time has elapsed, stop shaking and report current rpm to the log, perform liquid transfer of 80 percent of the previously-dispensed volume from the heater shaker to the destination plate, deactivate the heater, open the latch, process complete.\n",
+    "internal": "heater-shaker-test",
+    "labware": "\nOpentrons Tips for the Selected Pipette (https://shop.opentrons.com)\nOpentrons Heater Shaker Module-compatible labware (see five options in the protocol parameters section of the python script)\nSelected Source and Destination Labware ([see lists in the protocol parameters section of the python script] https://labware.opentrons.com/)\n",
+    "markdown": {
+        "author": "[Opentrons](https://opentrons.com/)\n\n\n",
+        "categories": "* Heater Shaker\n\t* Heater Shaker Beta Test\n\n",
+        "deck-setup": "![deck layout](https://opentrons-protocol-library-website.s3.amazonaws.com/custom-README-images/heater-shaker-test/Screen+Shot+2022-06-21+at+12.15.17+PM.png)\n</br>\n</br>\n**Slot 1**: Opentrons Heater Shaker Module with selected labware </br>\n**Slot 3**: Source Labware (well plate or reservoir) </br>\n**Slot 6**: Destination Labware (well plate or reservoir) </br>\n**Slot 11**: Opentrons Tips\n\n\n---\n\n",
+        "description": "This protocol performs beta-testing steps of the Opentrons Heater Shaker Module with user-determined parameters for selection of the target temperature of the heater shaker (37-95 degrees Celsius), the target shaking speed (recommended 200-2000 rpm although it is possible to go up to 3000 rpm), duration of time for shaking (minutes), n (dispense to every nth column of the heater shaker labware - to save run-time), the labware on the heater shaker (five options listed in the protocol parameters section of the python script), the source labware (a well plate or reservoir from the Opentrons Labware Library - see list in protocol parameters section of the python script), the destination labware (a well plate or reservoir from the Opentrons Labware Library - see list in protocol parameters section of the python script), the transfer volume, and the pipette to be used (any single- or multi-channel pipette). The beta-test protocol will open and close the heater shaker latch and report latch status to the log, set target temperature and proceed without waiting, report the current temperature to the log, report the selected target wells to the log, perform liquid transfers from the source labware to the heater shaker labware, wait to ensure the previously set temperature has been reached, start shaking and capture the start time, perform a pipette mix in the destination labware to demo a pipetting step NOT targeting the heater shaker but occurring during the timed shake, wait until the shake time has elapsed, stop shaking and report current rpm to the log, perform liquid transfer of 80 percent of the previously-dispensed volume from the heater shaker to the destination plate, deactivate the heater, open the latch, process complete.\n\n\n\n---\n\n\n\n",
+        "internal": "heater-shaker-test\n",
+        "labware": "* Opentrons Tips for the Selected Pipette (https://shop.opentrons.com)\n* Opentrons Heater Shaker Module-compatible labware (see five options in the protocol parameters section of the python script)\n* Selected Source and Destination Labware ([see lists in the protocol parameters section of the python script] https://labware.opentrons.com/)\n\n\n",
+        "notes": "If you have any questions about this protocol, please contact the Protocol Development Team by filling out the [Troubleshooting Survey](https://protocol-troubleshooting.paperform.co/).\n\n",
+        "pipettes": "* Selected single- or multi-channel Opentrons Gen2 Pipette - see list in the protocol parameters section of the python script (https://shop.opentrons.com)\n\n",
+        "process": "1. Input your protocol parameters using the parameters section on this page, then download your protocol.\n2. Ensure the OT App on your computer has been updated to version 6.1-beta.\n3. Ensure the robot software on your OT-2 has been updated with the corresponding version.\n4. Upload your protocol file (.py extension) to the [OT App](https://opentrons.com/ot-app) in the `Protocol` tab.\n5. Set up your deck and run labware position check using the OT App. For tips, check out our [support articles](https://support.opentrons.com/en/collections/1559720-guide-for-getting-started-with-the-ot-2).\n6. Hit 'Run'.\n\n",
+        "protocol-steps": "1. The protocol will open and then close the heater shaker latch (latch status reported to the log).\n2. The protocol will set the heater shaker target temperature and proceed without waiting (current temperature reported to the log).\n3. The protocol will report the selected heater shaker wells (to be targeted for dispense) to the log (based on every_nth_column parameter).\n4. Use the selected pipette to perform liquid transfers from the source labware to the heater shaker labware.\n5. Wait to ensure reaching of the previously set heater shaker target temperature (current temperature reported to the log).\n6. Start shaking (the protocol will capture the start time).\n7. Use the selected pipette to perform pipette mixing in the destination labware (to test pipetting steps NOT targeting the heater shaker but occurring during the timed shake).\n8. Wait until the shake time has elapsed.\n9. Stop shaking (current rpm reported to the log).\n10. Use the selected pipette to transfer 80 percent of the previously-dispensed liquid volume from the heater shaker to the destination labware.\n11. Deactivate the heater (passive cooling).\n12. Open the latch. Test process complete.\n\n\n",
+        "reagents": "Water for testing\n\n---\n\n",
+        "title": "Opentrons Heater Shaker Module Beta Test Protocol"
+    },
+    "notes": "If you have any questions about this protocol, please contact the Protocol Development Team by filling out the Troubleshooting Survey.",
+    "pipettes": "\nSelected single- or multi-channel Opentrons Gen2 Pipette - see list in the protocol parameters section of the python script (https://shop.opentrons.com)\n",
+    "process": "\nInput your protocol parameters using the parameters section on this page, then download your protocol.\nEnsure the OT App on your computer has been updated to version 6.1-beta.\nEnsure the robot software on your OT-2 has been updated with the corresponding version.\nUpload your protocol file (.py extension) to the OT App in the Protocol tab.\nSet up your deck and run labware position check using the OT App. For tips, check out our support articles.\nHit 'Run'.\n",
+    "protocol-steps": "\nThe protocol will open and then close the heater shaker latch (latch status reported to the log).\nThe protocol will set the heater shaker target temperature and proceed without waiting (current temperature reported to the log).\nThe protocol will report the selected heater shaker wells (to be targeted for dispense) to the log (based on every_nth_column parameter).\nUse the selected pipette to perform liquid transfers from the source labware to the heater shaker labware.\nWait to ensure reaching of the previously set heater shaker target temperature (current temperature reported to the log).\nStart shaking (the protocol will capture the start time).\nUse the selected pipette to perform pipette mixing in the destination labware (to test pipetting steps NOT targeting the heater shaker but occurring during the timed shake).\nWait until the shake time has elapsed.\nStop shaking (current rpm reported to the log).\nUse the selected pipette to transfer 80 percent of the previously-dispensed liquid volume from the heater shaker to the destination labware.\nDeactivate the heater (passive cooling).\nOpen the latch. Test process complete.\n",
+    "reagents": [],
+    "title": "Opentrons Heater Shaker Module Beta Test Protocol"
+}