Skip to content

Commit

Permalink
intro and outline for dry run
Browse files Browse the repository at this point in the history
  • Loading branch information
ecormany committed May 1, 2024
1 parent 81e6526 commit 7356db0
Showing 1 changed file with 30 additions and 0 deletions.
30 changes: 30 additions & 0 deletions api/docs/v2/parameters/use_case_dry_run.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,33 @@ The code examples will show how this single value can control:
- Reducing mix repetitions to save time.
- Returning tips (that never touched any liquid) to their racks.

To keep things as simple as possible, this use case only focuses on setting up and using the value of the dry run parameter, which could be just one of many parameters in a complete protocol.

Dry Run Definition
==================

First, we need to set up the dry run parameter. We want to set up a simple yes/no choice for the technician running the protocol, so we'll use a Boolean parameter::

def add_parameters(parameters):

parameters.add_bool(
variable_name="dry_run",
display_name="Dry Run",
description="Skip delays, shorten mix steps, and return tips to their racks.",
default=False
)

This parameter is set to ``False`` by default, assuming that most runs will be live runs. In other words, during run setup the technician will have to change the parameter setting to perform a dry run. If they leave it as is, the robot will perform a live run.

Additionally, since "dry run" can have different meanings in different contexts, it's important to include a ``description`` that indicates exactly what the parameter will control — in this case, three things. The following sections will show how to accomplish each of those when the dry run parameter is set to ``True``.

Skipping Delays
===============


Shortening Mix Steps
====================


Returning Tips
==============

0 comments on commit 7356db0

Please sign in to comment.