ecl-logo Documentation
ECL`

ExperimentDilute

ExperimentDilute[Sample]⟹Protocol

generates a Protocol to perform basic dilution of the provided liquid Sample with some amount of solvent.

    
Experiment Dilute performs the basic operation where a diluent is added to a liquid sample. If a new container is specified, the diluent is added to the source container first, and then the mixture is transferred to a new container. Note that if the Amount is set to less than the full amount, the Amount and Volume are used to calculate the desired concentration of the analyte after dilution, the diluent is then added to the source sample to attain the proper concentration for the entire sample, and finally the specified or calculated TotalVolume of mixture is transferred to the new container.
    

Experimental Principles

    Figure 1.1: Step 1: Liquid is added to the liquid samples. Step 2: If specified, the samples are incubated and/or mixed.

Instrumentation

    Super STAR

    Figure 2.1.1: An overview of the robotic workcell. It is capable of processing plate operations including incubation, shaking, and magnetic bead separation on-deck and centrifugation, filtration, and absorbance/fluorescence/luminescence measurement off-deck, with a robot arm facilitating the plate movements.
    Figure 2.1.2: Overhead view of the liquid handling instrument deck.

    Hamilton STARlet

    Figure 2.2.1: An overview of the robotic workcell. It is capable of processing plate operations including incubation, shaking, and magnetic bead separation on-deck and filtration and absorbance/fluorescence/luminescence measurement off-deck, with a robot arm facilitating the plate movements.
    Figure 2.2.2: Overhead view of the liquid handling instrument deck.

    Eppendorf Research Plus P200

    Figure 2.3: The diagram above lists the available pipette sizes and corresponding tip types that are available in the ECL.

    pipetus

    Figure 2.4: The above diagram lists the compatible serological tip sizes that are available at the ECL.

    Eppendorf Research Plus, 8-channel 1200uL

    Figure 2.5: 1 to 8 samples can be transferred at the same time using the 8 channel pipette.

Experiment Options

    General

    Amount

    The amount of a sample that should be diluted with a diluent. Note that if the Amount is set to less than All, the diluent is added to the source sample to attain the proper concentration for the entire sample, and the amount of mixture with the portion of original sample corresponding to Amount is transferred to the new container.
    Default Value: Automatic
    Default Calculation: Automatically set to the current volume of the sample, or the value necessary to reach the specified TargetConcentration.
    Pattern Description: All or Volume or Null.
    Programmatic Pattern: ((RangeP[0*Microliter, 20*Liter] | All) | Automatic) | Null
    Index Matches to: experiment samples

    TargetConcentration

    The desired final concentration of analyte after dilution of the input samples with the Diluent.
    Default Value: Automatic
    Default Calculation: Automatically calculated based on Amount and Volume options.
    Pattern Description: Greater than 0 molar or greater than 0 grams per liter or Null.
    Programmatic Pattern: ((GreaterP[0*Molar] | GreaterP[0*(Gram/Liter)]) | Automatic) | Null
    Index Matches to: experiment samples

    TargetConcentrationAnalyte

    The substance whose final concentration is attained with the TargetConcentration option.
    Default Value: Automatic
    Default Calculation: Automatically set to the first value in the Analytes field of the input sample, or, if not populated, to the first analyte in the Composition field of the input sample, or if none exist, the first identity model of any kind in the Composition field.
    Pattern Description: An object of type or subtype Model[Molecule], Model[Molecule, cDNA], Model[Molecule, Oligomer], Model[Molecule, Transcript], Model[Molecule, Protein], Model[Molecule, Protein, Antibody], Model[Molecule, Carbohydrate], Model[Molecule, Polymer], Model[Resin], Model[Resin, SolidPhaseSupport], Model[Lysate], Model[ProprietaryFormulation], Model[Virus], Model[Cell], Model[Cell, Mammalian], Model[Cell, Bacteria], Model[Cell, Yeast], Model[Tissue], Model[Material], or Model[Species] or Null.
    Programmatic Pattern: (ObjectP[IdentityModelTypes] | Automatic) | Null
    Index Matches to: experiment samples

    TotalVolume

    The desired total volume of the sample plus diluent. Note that if the Amount is set to less than All, the diluent is added to the source sample to attain the proper concentration for the entire sample, and TotalVolume mixture is transferred to the new container, and the portion of original sample corresponding in it equals to Amount.
    Default Value: Automatic
    Default Calculation: Automatically determined based on the TargetConcentration option values. If not specified and TargetConcentration is also not specified, an error is thrown.
    Pattern Description: Greater than or equal to 1 microliter and less than or equal to 20 liters or Null.
    Programmatic Pattern: (RangeP[1*Microliter, 20*Liter] | Automatic) | Null
    Index Matches to: experiment samples

    ContainerOut

    The desired type of container that should be used to prepare and house the diluted samples, with indices indicating grouping of samples in the same plates, if desired.
    Default Value: Automatic
    Default Calculation: Automatically set to the current container of the input sample.
    Pattern Description: An object of type or subtype Model[Container] or Object[Container] or a prepared sample or {Index, Container}
    Programmatic Pattern: ((ObjectP[{Model[Container], Object[Container]}] | _String) | {GreaterEqualP[1, 1] | Automatic, (ObjectP[{Model[Container], Object[Container]}] | _String) | Automatic}) | Automatic
    Index Matches to: experiment samples

    DestinationWell

    The desired position in the corresponding ContainerOut in which the resuspended samples will be placed.
    Default Value: Automatic
    Default Calculation: Automatically set to the current position of the input sample if ContainerOut is the current container of the input sample. Otherwise set to A1 in vessels, or an empty well of the specified plate.
    Pattern Description: Any well from A1 to H12.
    Programmatic Pattern: WellPositionP | Automatic
    Index Matches to: experiment samples

    Diluent

    The sample that should be added to the input sample, where the volume of this sample added is the TotalVolume option - the current sample volume.
    Default Value: Automatic
    Default Calculation: Automatically set to Model[Sample, "Milli-Q water"] if ConcentratedBuffer is not specified; otherwise set to Null.
    Pattern Description: An object of type or subtype Object[Sample] or Model[Sample] or a prepared sample or Null.
    Programmatic Pattern: ((ObjectP[{Object[Sample], Model[Sample]}] | _String) | Automatic) | Null
    Index Matches to: experiment samples

    ConcentratedBuffer

    The concentrated buffer which should be diluted by the BufferDilutionFactor in the final solution (i.e., the combination of the sample, ConcentratedBuffer, and BufferDiluent). The ConcentratedBuffer and BufferDiluent will be combined and then mixed with the sample, where the combined volume of these buffers is the difference between the Amount and the TotalVolume.
    Default Value: Null
    Pattern Description: An object of type or subtype Object[Sample] or Model[Sample] or a prepared sample or Null.
    Programmatic Pattern: (ObjectP[{Object[Sample], Model[Sample]}] | _String) | Null
    Index Matches to: experiment samples

    BufferDilutionFactor

    The dilution factor by which the concentrated buffer should be diluted in the final solution (i.e., the combination of the sample, ConcentratedBuffer, and BufferDiluent). The ConcentratedBuffer and BufferDiluent will be combined and then mixed with the sample, where the combined volume of these buffers is the difference between the Amount and the TotalVolume.
    Default Value: Automatic
    Default Calculation: If ConcentratedBuffer is specified, automatically set to the ConcentratedBufferDilutionFactor of that sample; otherwise, set to Null.
    Pattern Description: Greater than or equal to 1 or Null.
    Programmatic Pattern: (GreaterEqualP[1] | Automatic) | Null
    Index Matches to: experiment samples

    BufferDiluent

    The buffer used to dilute the sample such that ConcentratedBuffer is diluted by BufferDilutionFactor in the final solution. The ConcentratedBuffer and BufferDiluent will be combined and then mixed with the sample, where the combined volume of these buffers is the difference between the Amount and the TotalVolume.
    Default Value: Automatic
    Default Calculation: Automatically set to Model[Sample, "Milli-Q water"] if ConcentratedBuffer is specified; otherwise, resolves to Null.
    Pattern Description: An object of type or subtype Object[Sample] or Model[Sample] or a prepared sample or Null.
    Programmatic Pattern: ((ObjectP[{Object[Sample], Model[Sample]}] | _String) | Automatic) | Null
    Index Matches to: experiment samples

    Preparation

    Indicates if this unit operation is carried out primarily robotically or manually. Manual unit operations are executed by a laboratory operator and robotic unit operations are executed by a liquid handling work cell.
    Default Value: Automatic
    Pattern Description: Manual or Robotic.
    Programmatic Pattern: PreparationMethodP | Automatic

    WorkCell

    The automated workstation with a collection of integrated instruments on which this unit operation will be will be performed if Preparation -> Robotic.
    Default Value: Automatic
    Default Calculation: Automatically set to STAR if Preparation->Robotic.
    Pattern Description: STAR, bioSTAR, or microbioSTAR or Null.
    Programmatic Pattern: ((STAR | bioSTAR | microbioSTAR) | Automatic) | Null

    Incubation and Mixing

    Mix

    Indicates if mixing of the diluted samples will occur.
    Default Value: True
    Pattern Description: True or False.
    Programmatic Pattern: BooleanP
    Index Matches to: experiment samples

    MixType

    The style of motion used to mix the diluted samples solution following addition of liquid.
    Default Value: Automatic
    Default Calculation: Automatically set based on the Volume option and size of the container in which the sample is prepared.
    Pattern Description: Roll, Vortex, Sonicate, Pipette, Invert, Stir, Shake, Homogenize, Swirl, Disrupt, or Nutate or Null.
    Programmatic Pattern: (MixTypeP | Automatic) | Null
    Index Matches to: experiment samples

    NumberOfMixes

    Determines the number of times the sample is mixed for discrete mixing processes such as Pipette or Invert.
    Default Value: Automatic
    Pattern Description: Greater than or equal to 0 in increments of 1 or Null.
    Programmatic Pattern: (GreaterEqualP[0, 1] | Automatic) | Null
    Index Matches to: experiment samples

    MixUntilDissolved

    Indicates if the sample should be mixed in an attempt to thoroughly mix the sample with the diluent.
    Default Value: Automatic
    Default Calculation: Automatically set to True if MaxIncubationTime is specified, or False otherwise.
    Pattern Description: True or False or Null.
    Programmatic Pattern: (BooleanP | Automatic) | Null
    Index Matches to: experiment samples

    IncubationTime

    The duration for which the sample should be mixed/incubated following addition of liquid.
    Default Value: Automatic
    Default Calculation: Automatically set to 30 minutes unless MixType is set to Pipette, Swirl or Invert, in which case it is set to Null.
    Pattern Description: Greater than or equal to 0 hours and less than or equal to 72 hours or Null.
    Programmatic Pattern: (RangeP[0*Hour, 72*Hour] | Automatic) | Null
    Index Matches to: experiment samples

    MaxIncubationTime

    The maximum duration for which the samples should be mixed/incubated in an attempt to dissolve any solid components following addition of liquid.
    Default Value: Automatic
    Default Calculation: Automatically set based on the MixType if MixUntilDissolved is set to True. If MixUntilDissolved is False, resolves to Null.
    Pattern Description: Greater than or equal to 1 second and less than or equal to 72 hours or Null.
    Programmatic Pattern: (RangeP[1*Second, 72*Hour] | Automatic) | Null
    Index Matches to: experiment samples

    IncubationInstrument

    The instrument that should be used to incubate the sample following addition of liquid.
    Default Value: Automatic
    Default Calculation: Automatically set to an appropriate instrument based on container model and MixType, or Null if Mix is set to False.
    Pattern Description: An object of type or subtype Model[Instrument, Roller], Model[Instrument, OverheadStirrer], Model[Instrument, Vortex], Model[Instrument, Shaker], Model[Instrument, BottleRoller], Model[Instrument, Roller], Model[Instrument, Sonicator], Model[Instrument, HeatBlock], Model[Instrument, Homogenizer], Model[Instrument, Disruptor], Model[Instrument, Nutator], Model[Instrument, Thermocycler], Model[Instrument, EnvironmentalChamber], Model[Instrument, Pipette], Object[Instrument, Roller], Object[Instrument, OverheadStirrer], Object[Instrument, Vortex], Object[Instrument, Shaker], Object[Instrument, BottleRoller], Object[Instrument, Roller], Object[Instrument, Sonicator], Object[Instrument, HeatBlock], Object[Instrument, Homogenizer], Object[Instrument, Disruptor], Object[Instrument, Nutator], Object[Instrument, Thermocycler], Object[Instrument, EnvironmentalChamber], or Object[Instrument, Pipette] or Null.
    Programmatic Pattern: (ObjectP[Join[MixInstrumentModels, MixInstrumentObjects]] | Automatic) | Null
    Index Matches to: experiment samples

    IncubationTemperature

    Temperature at which the sample should be mixed/incubated for the duration of the IncubationTime following addition of liquid.
    Default Value: Automatic
    Default Calculation: Automatically set to Ambient, or Null if Mix is set to False or MixType is set to Pipette, Swirl or Invert.
    Pattern Description: Ambient or greater than or equal to -20 degrees Celsius and less than or equal to 500 degrees Celsius or Null.
    Programmatic Pattern: ((RangeP[$MinIncubationTemperature, $MaxIncubationTemperature] | Ambient) | Automatic) | Null
    Index Matches to: experiment samples

    AnnealingTime

    Minimum duration for which the sample should remain in the incubator allowing the system to settle to room temperature after the MixTime has passed if mixing while incubating.
    Default Value: Automatic
    Default Calculation: Automatically resolves to 0 Minute, or Null if Mix is set to False.
    Pattern Description: Greater than or equal to 0 minutes and less than or equal to 72 hours or Null.
    Programmatic Pattern: (RangeP[0*Minute, 72*Hour] | Automatic) | Null
    Index Matches to: experiment samples

    Mixing

    MixOrder

    Indicates if mixing/incubating are done for one sample after addition of liquid before advancing to the next (Serial) or all at once after liquid is added to all samples (Parallel).
    Default Value: Parallel
    Pattern Description: Serial or Parallel.
    Programmatic Pattern: ReadOrderP

    Model Input

    PreparedModelContainer

    Indicates the container in which a Model[Sample] specified as input to the experiment function will be prepared.
    Default Value: Automatic
    Default Calculation: If PreparedModelAmount is set to All and when the input model has a product associated with both Amount and DefaultContainerModel populated, automatically set to the DefaultContainerModel value in the product. Otherwise set to Model[Container, Vessel, "2mL Tube"].
    Pattern Description: An object of type or subtype Model[Container] or Null.
    Programmatic Pattern: (ObjectP[Model[Container]] | Automatic) | Null
    Index Matches to: experiment samples

    PreparedModelAmount

    Indicates the amount of a Model[Sample] specified as input to the experiment function that will be prepared in the PreparedModelContainer. When set to All and the input model sample is not preparable, the entire amount of the input model sample that comes from one of the Products is prepared. The selected product must have both Amount and DefaultContainerModel populated, and it must not be a KitProduct. When set to All and the input model is preparable such as water, 1 Milliliter of the input model sample is prepared.
    Default Value: Automatic
    Default Calculation: Automatically set to 1 Milliliter.
    Pattern Description: All or Count or Count or Mass or Volume or Null.
    Programmatic Pattern: ((RangeP[1*Microliter, 20*Liter] | RangeP[1*Milligram, 20*Kilogram] | GreaterP[0*Unit, 1*Unit] | GreaterP[0., 1.] | All) | Automatic) | Null
    Index Matches to: experiment samples

    Post Experiment

    SamplesOutStorageCondition

    The non-default conditions under which any new samples generated by this experiment should be stored after the protocol is completed. If left unset, the new samples will be stored according to their Models' DefaultStorageCondition.
    Default Value: Null
    Pattern Description: {AmbientStorage, EnclosedAmbientStorage, Refrigerator, Freezer, DeepFreezer, CryogenicStorage, YeastIncubation, YeastShakingIncubation, BacterialIncubation, BacterialShakingIncubation, MammalianIncubation, ViralIncubation, CrystalIncubation, AcceleratedTesting, IntermediateTesting, LongTermTesting, UVVisLightTesting} or Disposal or Null.
    Programmatic Pattern: (Alternatives[SampleStorageTypeP | Disposal]) | Null
    Index Matches to: experiment samples

Protocol Options

    Post Experiment

    MeasureWeight

    Indicates if any solid samples that are modified in the course of the experiment should have their weights measured and updated after running the experiment. Please note that public samples are weighed regardless of the value of this option.
    Default Value: Automatic
    Pattern Description: True or False or Null.
    Programmatic Pattern: (BooleanP | Automatic) | Null

    MeasureVolume

    Indicates if any liquid samples that are modified in the course of the experiment should have their volumes measured and updated after running the experiment. Please note that public samples are volume measured regardless of the value of this option.
    Default Value: Automatic
    Pattern Description: True or False or Null.
    Programmatic Pattern: (BooleanP | Automatic) | Null

    ImageSample

    Indicates if any samples that are modified in the course of the experiment should be freshly imaged after running the experiment. Please note that public samples are imaged regardless of the value of this option.
    Default Value: Automatic
    Pattern Description: True or False or Null.
    Programmatic Pattern: (BooleanP | Automatic) | Null

    Organizational Information

    Template

    A template protocol whose methodology should be reproduced in running this experiment. Option values will be inherited from the template protocol, but can be individually overridden by directly specifying values for those options to this Experiment function.
    Default Value: Null
    Pattern Description: An object of type or subtype Object[Protocol] or an object of type or subtype of Object[Protocol] with UnresolvedOptions, ResolvedOptions specified or Null.
    Programmatic Pattern: (ObjectP[Object[Protocol]] | FieldReferenceP[Object[Protocol], {UnresolvedOptions, ResolvedOptions}]) | Null

    Name

    A object name which should be used to refer to the output object in lieu of an automatically generated ID number.
    Default Value: Null
    Pattern Description: A string or Null.
    Programmatic Pattern: _String | Null

Example Calls

    Control the amount to of sample to dilute with the Amount option

    If Amount, TargetConcentration, and ContainerOut are all unspecified, the full amount of the sample is diluted in its current container:
    If Amount is specified to something besides the full amount of the sample (or if it is likewise Automatically set with the TargetConcentration option), all the sample is diluted in the source container, and then TotalVolume mixture is transferred out to ContainerOut:

    Control the diluent used to resuspend the samples

    Specify how much diluent to use with the Volume option:
    If Volume is not specified, and not obtainable from the TargetConcentration option, an error is thrown:

    Mix and Incubate parameters

    Indicate how the sample ought to be mixed or incubated following addition of diluent:
    Indicate if each sample should be mixed after liquid is added in sequence (Serial) or all after all liquid was added to all samples (Parallel):

Preferred Input Containers

    96-well 2mL Deep Well Plate
    2mL Tube

Warnings and Errors

    Messages  (29)

    BufferDilutionMismatched  (1)

    If BufferDilutionFactor and/or BufferDiluent are specified, ConcentratedBuffer must also be specified:

    CannotResolveAmount  (1)

    If a sample has no amount populated in its Volume field and no Amount is specified, throw an error:

    CannotResolveTotalVolume  (1)

    If TotalVolume is not specified and cannot be resolved from TargetConcentration, an error is thrown:

    ConcentrationRatioMismatch  (1)

    If Amount, TotalVolume, and TargetConcentation are all specified, they must not be conflicting:

    ContainerOutMismatchedIndex  (1)

    If specifying ContainerOut with indices, containers of different models cannot have the same index:

    ContainerOverOccupied  (1)

    If more positions in the destination container are requested than are available, throw an error:

    DeprecatedModels  (1)

    Deprecated models are not supported for any option value:

    DestinationWellDoesntExist  (1)

    If DestinationWell is specified, it must be an existing position in the specified or resolved ContainerOut:

    DiluteInitialVolumeOverContainerMax  (1)

    If transferring to a new container, the volume needed to dilute in the source container first must be less than the MaxVolume of the source container:

    DilutePreparationInvalid  (1)

    Thow an error if the specified preparation cannot be performed:

    DiluteTotalVolumeOverContainerMax  (1)

    If the specified TotalVolume is greater than the specified or resolved ContainerOut, throw an error:

    DiscardedSamples  (1)

    Discarded objects are not supported as inputs or options:

    DuplicateName  (1)

    If the specified name already exists for a Dilute protocol, an error is thrown:

    DuplicateSampleConflictingConditions  (1)

    If the same sample is specified more than once, it will only be diluted once. In this case, all the options for these samples must be identical:

    InputContainsTemporalLinks  (1)

    Throw a message if given a temporal link:

    MixInstrumentTypeMismatch  (1)

    If the IncubationInstrument and MixType options do not agree, an error is thrown:

    MixTypeNumberOfMixesMismatch  (1)

    Thow an error if NumberOfMixes is specified for incubation types:

    ObjectDoesNotExist  (7)

    Do NOT throw a message if we have a simulated container but a simulation is specified that indicates that it is simulated:

    Do NOT throw a message if we have a simulated sample but a simulation is specified that indicates that it is simulated:

    If an object does not exist, throw an error and return $Failed immediately:

    Throw a message if we have a container that does not exist (ID form):

    Throw a message if we have a container that does not exist (name form):

    Throw a message if we have a sample that does not exist (ID form):

    Throw a message if we have a sample that does not exist (name form):

    OverspecifiedBuffer  (1)

    Both Diluent and ConcentratedBuffer cannot be simultaneously requested:

    PartialResuspensionContainerInvalid  (1)

    If the ContainerOut is set to the current container, Amount must be equal to the full Volume of the specified sample:

    ResuspendMixTypeIncubationMismatch  (1)

    Thow an error if Incubation options are specified for Pipette/Swirl/Invert mix types:

    SampleStateInvalid  (1)

    If the input sample is a solid, it cannot be diluted:

    UnknownAmount  (1)

    If a sample is being diluted but doesn't have a mass or count populated, throw a warning but proceed:

Last modified on Tue 2 Sep 2025 18:12:58

EMERALD CLOUD LAB
15500 Wells Port Drive
Austin, TX 78728
© 2025 Emerald Cloud Lab, Inc.