ecl-logo Documentation
ECL`

ExperimentFreezeCells

ExperimentFreezeCells[Samples]Protocol

creates a Protocol to generate frozen cells stocks from Samples containing mammalian, yeast, or bacterial cells.

    
ExperimentFreezeCells prepares small-volume cell stocks in cryogenic vials, provides precise control over the temperature during freezing, and stores the frozen cell stocks for long-term cryogenic preservation. Since uncontrolled freezing can damage the cellular integrity and reduce post-thaw viability, ExperimentFreezeCells offers two strategies to achieve the optimal rate for cell preservation: ControlledRateFreezer, which electronically regulates temperature profiles with cooling rate from 0.01 °C/min to 2 °C/min, and InsulatedCooler, which employs traditional cell-freezing containers filled with coolant, providing an approximate cooling rate of 1 °C/min when placed in an ultra-low temperature freezer. Following the initial freezing, samples are stored under the desired conditions for future use. Samples may be frozen in batches to ensure uniformly viable cell stocks. ExperimentFreezeCells processes samples using a fixed preparation procedure determined by the selected CryoprotectionStrategy. When CryoprotectionStrategy is set to AddCryoprotectant or ChangeMedia, the procedure includes adding cryoprotectant solutions to prevent deleterious ice formation during freezing, and, in the case of ChangeMeida, removing existing media. Intermediate containers are not supported; therefore, input samples must be provided in centrifuge-compatible containers when using ChangeMedia. For a list of compatible container models, refer to PreferredInputContainers section.
    

Experimental Principles

    Figure 1.1: Procedural overview of a cell freezing experiment if CryoprotectionStrategy is ChangeMedia. Step 1: Cell pelleting. Step 2: Replace existing media in supernatant with CryoprotectantSolution. Step 3: Optional aliquoting transfers resuspended cells in new media into one or more cryogenic vials. Step 4: The cell samples in cryogenic vials are frozen using the FreezingStrategy (ControlledRateFreezer or InsulatedCooler). The samples are moved into long-term storage after the experiment is completed.
    Figure 1.2: Procedural overview of a cell freezing experiment if CryoprotectionStrategy is AddCryoprotectant or None. Step 1: Optional aliquoting transfers some or all of an input cell sample into one or more cryogenic vials. Step 2: Optional cryoprotection is performed using AddCryoprotectant CryoprotectionStrategy, for which the user may specify simple addition of cryoprotectants directly to the cryogenic vials. Step 3: The cell samples in cryogenic vials are frozen using the FreezingStrategy (ControlledRateFreezer or InsulatedCooler). The samples are moved into long-term storage after the experiment is completed.

Instrumentation

    Freezers

    Freezing Racks

    VIA Freeze Research

    Figure 2.1: Instrument diagram for the VIA Freeze Research controlled rate cell freezer.

    Stirling UltraCold SU780UE

    Figure 2.2: Diagram for Mr. Frosty insulated coolers used with an ultra-low temperature freezer.

Experiment Options

    General

    NumberOfReplicates

    Specifies how many identical frozen cell stock samples are prepared from each provided sample. For example, if NumberOfReplicates is set to 2, two cryogenic vials with identical contents are generated as a result of this experiment. This also indicates that the samples are transferred into new cryogenic vials. If NumberOfReplicates is set to Null, one and only one CryogenicSampleContainer is generated.
    Default Value: Null
    Pattern Description: Greater than or equal to 2 and less than or equal to 48 in increments of 1 or Null.
    Programmatic Pattern: RangeP[2, 48, 1] | Null

    FreezingStrategy

    The manner in which the cell sample(s) are frozen. ControlledRateFreezer employs a programmable instrument that electronically controls the sample temperature to freeze the cell sample(s), allowing the user to specify a multi-stage TemperatureProfile if desired. InsulatedCooler employs a rack submerged in a coolant solution, which is placed in a freezer to freeze the cell sample(s).
    Default Value: Automatic
    Default Calculation: If either Coolant or InsulatedCoolerFreezingTime is specified, or an ultra-low temperature freezer is specified as Freezer, or CryogenicSampleContainer is set to a cryogenic vial model with MaxVolume larger than 2 Milliliter, automatically set to InsulatedCooler. Otherwise, automatically set to ControlledRateFreezer.
    Pattern Description: InsulatedCooler or ControlledRateFreezer.
    Programmatic Pattern: FreezeCellMethodP | Automatic

    CellType

    The type of the most abundant cells that are thought to be present in this sample. Options include Bacterial, Mammalian, and Yeast.
    Default Value: Automatic
    Default Calculation: Automatically set to match the value of CellType of the input sample if it is populated, otherwise set to Bacterial.
    Pattern Description: Bacterial, Mammalian, or Yeast.
    Programmatic Pattern: (Bacterial | Mammalian | Yeast) | Automatic
    Index Matches to: experiment samples

    CultureAdhesion

    The manner of cell growth the cells in the sample are thought to employ. Options include SolidMedia, Suspension, and Adherent. SolidMedia cells grow in colonies on a nutrient rich substrate, suspended cells grow free floating in liquid media, and adherent cells grow attached to a substrate.
    Default Value: Automatic
    Default Calculation: Automatically set to match the CultureAdhesion value of the input sample if it is populated, otherwise set to Suspension.
    Pattern Description: Adherent, Suspension, or SolidMedia.
    Programmatic Pattern: CultureAdhesionP | Automatic
    Index Matches to: experiment samples

    CryogenicSampleContainer

    The desired container model for freezing the cell stock, or, if samples are frozen in situ, the original container holding the input sample. All resulting containers are frozen and stored under cryogenic conditions.
    Default Value: Automatic
    Default Calculation: If Aliquot is False, automatically set to the original container holding the input sample. If Aliquot is True and FreezingStrategy is set to ControlledRateFreezer, automatically set to Model[Container, Vessel, "2mL Cryogenic Vial"]. If Aliquot is True and FreezingStrategy is set to InsulatedCooler, automatically set to a container with a CryogenicVial Footprint and sufficient capacity to hold the cell stock(s), accounting for ice expansion by limiting fill volume to 75% to prevent vial rupture.
    Pattern Description: An object of type or subtype Object[Container, Vessel] or Model[Container, Vessel] or a prepared sample.
    Programmatic Pattern: (ObjectP[{Object[Container, Vessel], Model[Container, Vessel]}] | _String) | Automatic
    Index Matches to: experiment samples

    CryoprotectionStrategy

    The manner in which the cell sample(s) are processed prior to freezing in order to protect the cells from detrimental ice formation. If ChangeMedia is selected, the entire input sample is pelleted, the existing media is removed and replaced with CryoprotectantSolution, resulting in cell stocks suspended in CryoprotectantSolution. If AddCryoprotectant is selected, the CryoprotectantSolution and a portion of the input sample is added directly to the CryogenicSampleContainer when Aliquot is True, or the CryoprotectantSolution is added directly to the input sample if freezing samples in situ is desired. In both cases, the resulting cell stocks consist of cells in the original medium supplemented with CryoprotectantSolution. If None is selected, the existing media is left unchanged, and the sample is mixed before being put inside of Freezer to ensure a uniform suspension.
    Default Value: Automatic
    Default Calculation: Automatically set to ChangeMedia if any of CellPelletCentrifuge, CellPelletTime, CellPelletIntensity, or CellPelletSupernatantVolume are specified. Otherwise, automatically set to AddCryoprotectant.
    Pattern Description: ChangeMedia, AddCryoprotectant, or None.
    Programmatic Pattern: (ChangeMedia | AddCryoprotectant | None) | Automatic
    Index Matches to: experiment samples

    Media Changing

    CellPelletCentrifuge

    The centrifuge used to pellet the cell sample(s) in order to remove the existing media and replace with CryoprotectantSolution. See Figure 3.1 for CellPelletCentrifuge models compatible with common container footprints. For complete details on all CellPelletCentrifuge models, refer to the "Instrumentation" section of the ExperimentCentrifuge helpfile.
    Figure 3.1: Common CellPelletCentrifuges and Operating Specifications
    Default Value: Automatic
    Default Calculation: Automatically set to a centrifuge that can attain the specified CellPelletIntensity and is compatible with the sample in its current container if CryoprotectionStrategy is set to ChangeMedia.
    Pattern Description: An object of type or subtype Model[Instrument, Centrifuge] or Object[Instrument, Centrifuge] or Null.
    Programmatic Pattern: (ObjectP[{Model[Instrument, Centrifuge], Object[Instrument, Centrifuge]}] | Automatic) | Null
    Index Matches to: experiment samples

    CellPelletTime

    The duration of time for which the sample(s) are centrifuged in order to pellet the cells, enabling removal of existing media.
    Default Value: Automatic
    Default Calculation: Automatically set to 5 Minute if CryoprotectionStrategy is set to ChangeMedia.
    Pattern Description: Greater than or equal to 0 minutes and less than or equal to 72 hours or Null.
    Programmatic Pattern: (RangeP[0*Minute, $MaxExperimentTime] | Automatic) | Null
    Index Matches to: experiment samples

    CellPelletIntensity

    The rotational speed or force applied to the cell sample(s) by centrifugation in order to create a pellet, enabling removal of existing media.
    Default Value: Automatic
    Default Calculation: If CryoprotectionStrategy is set to ChangeMedia, automatically set to the default value effective for pelleting the given CellType option: for Mammalian is 300 g, for Bacterial is 2000 g, and for Yeast is 1000 g.
    Pattern Description: Greater than or equal to 0 revolutions per minute and less than or equal to 80000 revolutions per minute or greater than or equal to 0 standard accelerations due to gravity on the surface of the earth and less than or equal to 504000 standard accelerations due to gravity on the surface of the earth or Null.
    Programmatic Pattern: ((RangeP[0*RPM, $MaxCentrifugeSpeed] | RangeP[0*GravitationalAcceleration, $MaxRelativeCentrifugalForce]) | Automatic) | Null
    Index Matches to: experiment samples

    CellPelletSupernatantVolume

    The volume of supernatant to be removed from the cell sample(s) following pelleting.
    Default Value: Automatic
    Default Calculation: Automatically set to All if CryoprotectionStrategy is set to ChangeMedia.
    Pattern Description: All or Volume or Null.
    Programmatic Pattern: ((All | RangeP[1*Microliter, 20*Liter]) | Automatic) | Null
    Index Matches to: experiment samples

    Cryoprotection

    CryoprotectantSolution

    The solution which contains high concentration of cryoprotective agents, such as glycerol and DMSO. The cryoprotectant solution protects the cells during freezing and thawing by preventing ice crystals from forming inside or around cells. See Figure 3.2 for more information about suggested cryoprotectant solutions for different cell types and strategies.
    Figure 3.2: This table indicates how the CellType and CryoprotectionStrategy options impact the resolution of CryoprotectantSolution when the CryoprotectantSolution is not specified.
    Default Value: Automatic
    Default Calculation: If CryoprotectionStrategy is set to AddCryoprotectant, CryoprotectantSolution is automatically set to Model[Sample, StockSolution, "50% Glycerol in Milli-Q water, Autoclaved"] for bacterial and yeast cells, and to Model[Sample, StockSolution, "30% Glycerol in Milli-Q water, Autoclaved"] for mammalian cells. If CryoprotectionStrategy is set to ChangeMedia, CryoprotectantSolution is automatically set to Model[Sample, "Gibco Recovery Cell Culture Freezing Medium"] for mammalian cells, to Model[Sample, StockSolution, "15% glycerol, 0.5% sodium chloride, Autoclaved"] for bacterial cells, and to Model[Sample, StockSolution, "30% Glycerol in Milli-Q water, Autoclaved"] for yeast cells.
    Pattern Description: An object of type or subtype Model[Sample] or Object[Sample] or a prepared sample or Null.
    Programmatic Pattern: ((ObjectP[{Model[Sample], Object[Sample]}] | _String) | Automatic) | Null
    Index Matches to: experiment samples

    CryoprotectantSolutionVolume

    The amount of CryoprotectantSolution to be added to the cell sample.
    Default Value: Automatic
    Default Calculation: If CryoprotectionStrategy is set to ChangeMedia, the volume is automatically set to match the CellPelletSupernatantVolume that is removed following pelleting. This volume is used to resuspend the cell pellet obtained from the entire sample, prior to aliquoting into cryogenic vials, if applicable. If CryoprotectionStrategy is set to AddCryoprotectant, the volume is automatically set to 50% of the sample volume to be mixed with. When Aliquot is True, this corresponds to 50% of the AliquotVolume. When Aliquot is False, this corresponds to 50% of the total input sample volume.
    Pattern Description: Greater than or equal to 0 milliliters and less than or equal to 180 milliliters or Null.
    Programmatic Pattern: (RangeP[0*Milliliter, 180*Milliliter] | Automatic) | Null
    Index Matches to: experiment samples

    CryoprotectantSolutionTemperature

    The temperature of the CryoprotectantSolution prior to its addition to the cell sample(s). If set to Chilled, the CryoprotectantSolution is placed in a cooler maintained at 4 Celsius for the following duration depending on the CryoprotectantSolutionVolume multiplied by the NumberOfReplicates: 20 Minute for a total volume less than 5 Milliliter, 1 Hour for a total volume of at least 5 Milliliter but no more than 50 Milliliter, and 2 Hour for a total volume greater than 50 Milliliter.
    Default Value: Automatic
    Default Calculation: Automatically set to Chilled if CryoprotectionStrategy is set to AddCryoprotectant or ChangeMedia.
    Pattern Description: Ambient or Chilled or Null.
    Programmatic Pattern: ((Ambient | Chilled) | Automatic) | Null

    Aliquoting

    AliquotVolume

    The volume of suspended cell sample that is transferred into new cryogenic sample containers. If CryoprotectionStrategy is set to ChangeMedia, the entire input sample is pelleted and resuspended in CryoprotectantSolution. In this case, the AliquotVolume refers to the specified amount of the resuspended cells being transferred into new cryogenic sample containers. If CryoprotectionStrategy is set to AddCryoprotectant or None, AliquotVolume refers to the specified amount of the well-mixed original input sample that is transferred into new cryogenic containers.
    Default Value: Automatic
    Default Calculation: If Aliquot is True and CryoprotectionStrategy is set to ChangeMedia or None, automatically set to the lesser of 75% of the volume of the CryogenicSampleContainer (to account for ice expansion and prevent vial rupture) or the total volume of the suspended cell sample divided equally among the number of frozen cell stocks being prepared. If Aliquot is True and CryoprotectionStrategy is set to AddCryoprotectant, automatically set to the lesser of 75% of the volume of the CryogenicSampleContainer minus the volume of CryoprotectantSolution or the total volume of the suspended cell sample divided equally among the number of frozen cell stocks being prepared.
    Pattern Description: All or Volume or Null.
    Programmatic Pattern: ((RangeP[0*Milliliter, 5*Milliliter] | All) | Automatic) | Null
    Index Matches to: experiment samples

    Cell Freezing

    FreezingRack

    The insulated cooler rack or controlled rate freezer-compatible sample rack used to freeze the cell sample(s). See Figure 3.3 or Figure 2.1 and 2.2 in the "Instrumentation" section of the ExperimentFreezeCells helpfile for more information.
    Figure 3.3: Comparison for the controlled rate freezer-compatible rack or the insulated coolers.
    Default Value: Automatic
    Default Calculation: Automatically set to Model[Container, Rack, "2mL Cryo Rack for VIA Freeze"] if FreezingStrategy is set to ControlledRateFreezer. If FreezingStrategy is set to InsulatedCooler, automatically set to a rack that can accommodate the vials containing the experiment samples.
    Pattern Description: An object of type or subtype Model[Container, Rack], Object[Container, Rack], Model[Container, Rack, InsulatedCooler], or Object[Container, Rack, InsulatedCooler] or a prepared sample.
    Programmatic Pattern: (ObjectP[{Model[Container, Rack], Object[Container, Rack], Model[Container, Rack, InsulatedCooler], Object[Container, Rack, InsulatedCooler]}] | _String) | Automatic
    Index Matches to: experiment samples

    Freezer

    The device supplies low temperatures and either electronically regulates the TemperatureProfile or drives the cooling process of an insulated cooler placed inside to cool the cell sample(s). A controlled-rate freezer allows user-programmable cooling TemperatureProfile with cooling rates from 0.01 Celsius/Minute to 2 Celsius/Minute, whereas an ultra-low temperature freezer holds an insulated cooler filled with Coolant, providing an approximate cooling rate of of 1 Celsius/Minute. See "Instrumentation" section of the ExperimentFreezeCells helpfile for more information.
    Default Value: Automatic
    Default Calculation: Automatically set to Model[Instrument, ControlledRateFreezer, "VIA Freeze Research"] if FreezingStrategy is set to ControlledRateFreezer. Otherwise, automatically set to Model[Instrument, Freezer, "Stirling UltraCold SU780UE"] maintained at -80 Celsius. In order to maximize the efficiency of freezer storage in the laboratory, user specification of a particular Object[Instrument, Freezer] is not supported.
    Pattern Description: An object of type or subtype Model[Instrument, ControlledRateFreezer], Object[Instrument, ControlledRateFreezer], or Model[Instrument, Freezer]
    Programmatic Pattern: ObjectP[{Model[Instrument, ControlledRateFreezer], Object[Instrument, ControlledRateFreezer], Model[Instrument, Freezer]}] | Automatic
    Index Matches to: experiment samples

    Coolant

    Liquid that fills the chamber of the insulated cooler in which the sample rack is immersed. The coolant is employed to achieve gradual cooling of the cell sample(s).
    Default Value: Automatic
    Default Calculation: Automatically set to Model[Sample, "Isopropanol"] if FreezingStrategy is set to InsulatedCooler.
    Pattern Description: An object of type or subtype Model[Sample] or Object[Sample] or a prepared sample or Null.
    Programmatic Pattern: ((ObjectP[{Model[Sample], Object[Sample]}] | _String) | Automatic) | Null
    Index Matches to: experiment samples

    InsulatedCoolerFreezingTime

    The minimum duration for which the cell stock(s) within an insulated cooler are kept within the Freezer to freeze the cells prior to being transported to SamplesOutStorageCondition.
    Default Value: Automatic
    Default Calculation: Automatically set to 12 Hour if FreezingStrategy is set to InsulatedCooler.
    Pattern Description: Greater than or equal to 4 hours and less than or equal to 72 hours or Null.
    Programmatic Pattern: (RangeP[4*Hour, $MaxExperimentTime] | Automatic) | Null

    TemperatureProfile

    The series of cooling steps applied to the cell sample(s). The specified time is cumulative (i.e., the total time elapsed from the beginning of freezing is specified at each time point) and the profile linearly interpolates between the specified points. For example, between the points {0 Celsius, 10 Minute} and {-60 Celsius, 40 Minute}, the temperature would decrease at a constant rate of 2 Celsius/Minute for 30 Minutes. The last specified temperature is held until the samples are transported to the final storage. An initial temperature is assumed to be 25 Celsius at the initial time point.
    Default Value: Automatic
    Default Calculation: If FreezingStrategy is set to ControlledRateFreezer, automatically set to a profile which results in linear cooling at 1 Celsius per Minute beginning at 25 Celsius and terminating at -80 Celsius.
    Pattern Description: List of one or more {Temperature, Time} entries or Null.
    Programmatic Pattern: ({{RangeP[-100*Celsius, 25*Celsius], RangeP[0*Hour, 24*Hour]}..} | Automatic) | Null

    Storage

    SamplesOutStorageCondition

    The long-term storage condition for the cell sample(s) after freezing.
    Default Value: CryogenicStorage
    Pattern Description: DeepFreezer or CryogenicStorage.
    Programmatic Pattern: CellStorageTypeP
    Index Matches to: experiment samples

Sample Prep Options

    Aliquoting

    Aliquot

    Indicates whether to prepare cell stocks in new cryogenic vials rather than in the current container of the provided sample. If CryoprotectionStrategy is set to ChangeMedia, aliquoting occurs after pelleting the entire sample and replacing the existing media with CryoprotectantSolution. If CryoprotectionStrategy is set to AddCryoprotectant or None, aliquoting occurs before the addition of CryoprotectantSolution. See Figure 1.1 and 1.2 in the "Experimental Principles" section of the ExperimentFreezeCells helpfile for more information.
    Default Value: Automatic
    Default Calculation: Automatically set to True if AliquotVolume, NumberOfReplicates, or a new CryogenicSampleContainer is specified, if the sample's current container has a Footprint other than CryogenicVial, or if the total volume of the cell stock exceeds 75% of the current container's maximum capacity. Otherwise, set to False.
    Pattern Description: True or False.
    Programmatic Pattern: BooleanP | Automatic
    Index Matches to: experiment samples

Protocol Options

    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 Results

    Generating FreezeCells protocols with manual workflow:
    • This protocol prepares multiple frozen cell stocks starting from a preceptrol culture (freeze-dried product). This manual workflow involves reconstituting the freeze-dried powder sample in LB broth in a cell culture tube, incubating the tube in a standard bacterial shaking incubator, monitoring the growth by measuring optical density at 600nm. The culture is then aliquoted into six identical cryogenic sample containers with cryoprotectant solutions added, and frozen using a controlled rate freezer with a customizable cooling temperature profile and equipped with real-time temperature monitoring.
    ExperimentCellPreparation[
        {
            InoculateLiquidMedia[
                Sample -> Model[Sample, "E.coli 10798"],
                DestinationMediaContainer -> Model[Container, Vessel, "Falcon Round-Bottom Polypropylene 14mL Test Tube With Cap"],
             ResuspensionMediaVolume -> 1 Milliliter,
             Volume -> 1 Milliliter,
                MediaVolume -> 5 Milliliter,
                DestinationMedia -> Model[Sample, Media, "LB (Liquid)"],
                SampleOutLabel -> "Rehydrated K12 cells"
            ],
            IncubateCells[
                Sample -> "Rehydrated K12 cells",
                CellType -> Bacterial,
                CultureAdhesion -> Suspension,
                Time -> 16 Hour
            ],
         QuantifyCells[
    Sample -> "Rehydrated K12 cells",
    Methods -> Absorbance,
    AbsorbanceMethod -> Cuvette,
    RecoupSample -> False,
    QuantificationUnit -> OD600,
    AbsorbanceAliquot -> True,
    AbsorbanceAliquotAmount -> 800 Microliter
    ],
            FreezeCells[
                Sample -> "Rehydrated K12 cells",
                FreezingStrategy -> ControlledRateFreezer,
                TemperatureProfile -> {{-10 Celsius, 35 Minute},{-10 Celsius, 40 Minute},{-45 Celsius, 75 Minute},{-45 Celsius, 80 Minute},{-80 Celsius, 115 Minute}},
                CryoprotectionStrategy -> AddCryoprotectant,
                CryoprotectantSolution -> Model[Sample, StockSolution, "50% Glycerol in Milli-Q water, Autoclaved"],
                CryogenicSampleContainer Model[Container, Vessel, "2mL Cryogenic Vial"],
                NumberOfReplicates -> 6
            ]
        }
    ]
    • Extracting the FreezeCells subprotocol, we will look more closely at this subprotocol.
    • Inspecting the actual environmental data recorded during freezing process in the controlled rate freezer.
    • Extracting the new samples from this workflow (the cell culture tube and six frozen cell stocks) from the parent protocol .
    • Inspecting the new samples.
    • This protocol prepares multiple frozen cell stocks starting from a cryopreserved culture. This manual workflow involves inoculating the frozen cell stock we prepared from the previous protocol into a cell culture flask, and incubating the flask in a standard bacterial shaking incubator. The culture is then aliquoted into twenty-four identical cryogenic sample containers with cryoprotectant solutions added, with FreezingStrategy default to ControlledRateFreezer and CryogenicSampleContainer default to 2mL Cryogenic Vial.
    ExperimentCellPreparation[
        {
            InoculateLiquidMedia[
                Sample -> Object[Sample, "E.Coli K12 cells previously frozen in cryovial for example notebook"],
                Destination -> Model[Container, Vessel, "125mL Erlenmeyer Flask"],
                MediaVolume -> 30 Milliliter,
                DestinationMedia -> Model[Sample, Media, "LB (Liquid)"],
                SampleOutLabel -> "My reviving cryopreserved cells"
            ],
            IncubateCells[
                Sample -> "My reviving cryopreserved cells",
                CellType -> Bacterial,
                CultureAdhesion -> Suspension,
                Time -> 24 Hour
            ],
            FreezeCells[
                Sample -> "My reviving cryopreserved cells",
                CryoprotectionStrategy -> AddCryoprotectant,
                NumberOfReplicates -> 24
            ]
        }
    ]
    • Extracting the FreezeCells subprotocol, we will look more closely at this subprotocol.
    • Inspecting the actual environmental data recorded during freezing process in the controlled rate freezer.
    • Inspecting the final values for options without any specified values.
    Generating and comparing standalone FreezeCells protocols with different FreezingStrategies or CryoprotectionStrategies:
    • This standalone protocol prepares a single copy of frozen cell stock from each sample that has already been transferred into cryogenic vials with FreezingStrategy set to ControlledRateFreezer and CryoprotectionStrategy set to None. With CryoprotectionStrategy set to None, no cryoprotectant reagents are added. The samples are simply mixed to ensure a uniform suspension before freezing.
    ExperimentFreezeCells[
        {
            Object[Sample, "Bacterial cell sample 1 in 2mL Cryovial for ExperimentFreezeCells example notebook"],
            Object[Sample, "Bacterial cell sample 2 in 2mL Cryovial for ExperimentFreezeCells example notebook"]
         },
        FreezingStrategy -> ControlledRateFreezer,
        CryoprotectionStrategy -> None
    ]
    • This standalone protocol prepares a single copy of frozen cell stock from each sample that has already been transferred into cryogenic vials with FreezingStrategy set to InsulatedCooler and CryoprotectionStrategy set to AddCryoprotectant. This InsulatedCooler strategy provides an approximate cooling rate of 1 °C per minute in a 80 °C freezer. It is implemented by placing a FreezingRack immersed in a coolant (e.g., isopropanol) within an insulated cooler then placed inside the freezer.
    ExperimentFreezeCells[
        {
            Object[Sample, "Bacterial cell sample 3 in 2mL Cryovial for ExperimentFreezeCells example notebook"],
            Object[Sample, "Bacterial cell sample 4 in 2mL Cryovial for ExperimentFreezeCells example notebook"]
         },
        FreezingStrategy -> InsulatedCooler,
        InsulatedCoolerFreezingTime -> 12 Hour,
        FreezingRack Model[Container, Rack, InsulatedCooler, "2mL Mr. Frosty Rack"],
        Coolant Model[Sample, "Isopropanol"],
        Freezer Model[Instrument, Freezer, "Stirling UltraCold SU780UE"],
        CryoprotectionStrategy -> AddCryoprotectant
    ]
    • Inspecting the actual environmental data recorded during freezing process in the 80 °C freezer.
    • This standalone protocol prepares multiple frozen cell stocks from a sample in a plate with FreezingStrategy set to InsulatedCooler and CryoprotectionStrategy set to ChangeMedia. With CryoprotectionStrategy set to ChangeMedia strategy, the entire input sample container is centrifuged to pellet the cells, the supernatant is aspirated, and the pellets are resuspended in fresh cryoprotectant solution. The resuspended culture is then aliquoted into ten cryogenic containers and frozen using an insulated cooler.
    ExperimentFreezeCells[
        Object[Sample, "Bacterial cell sample in A2 of 24-well V-bottom plate for ExperimentFreezeCells example notebook"],
        NumberOfReplicates -> 10,
    FreezingStrategy -> InsulatedCooler,
        CryoprotectionStrategy -> ChangeMedia,
        CellPelletIntensity -> 2000 GravitationalAcceleration,
        CellPelletTime -> 5 Minute,
        CellPelletSupernatantVolume -> All,
        CryoprotectantSolution Model[Sample, StockSolution, "15% glycerol, 0.5% sodium chloride, Autoclaved"]
    ]
    Reviewing and comparing the results:
    • Reviewing the CryoprotectionStrategy:
    Adding glycerol as cryoprotectant prevents deleterious ice formation during freezing. If None is selected, the existing media is left unchanged, and the sample is simply mixed to ensure a uniform suspension. If ChangeMedia is selected, the entire input sample is pelleted, the existing media is removed and replaced with CryoprotectantSolution, resulting in cell stocks suspended in cryoprotectant solution. If AddCryoprotectant is selected, the CryoprotectantSolution is added to the input sample. This can be set by CryoprotectantStrategy option.
    PlotTable[{preparedVialsProtocol,addingCryoprotectantProtocol,changingMediaProtocol}, {CryoprotectionStrategies[[1]], CryoprotectantSolutions[[1]][Model]}]
    If ChangeMedia is selected, a FreezeCellsPelletProtocol is generated which uses centrifuge to pellet the cell samples before the media exchange. For all types of cryoprotection strategies, a FreezeCellsTransfer protocol specifying the aliquoting of the input cell samples to CryogenicSampleContainers, resuspending the cells, and transferring of CryoprotectantSolutions to CryogenicSampleContainers prior to freezing is generated.
    PlotTable[{preparedVialsProtocol,addingCryoprotectantProtocol,changingMediaProtocol}, {FreezeCellsPelletProtocol, FreezeCellsTransferProtocol}]
    • Reviewing the FreezingStrategy:
    Cells may be frozen in traditional insulated cooler filled with a coolant and placed in a static temperature freezer, or in a controlled rate freezer instrument with electronic control of the temperature. InsulatedCooler employs a freezing rack submerged in a coolant solution, such as isopropanol, which is placed in a freezer to freeze the cell sample(s). ControlledRateFreezer employs a programmable instrument that electronically controls the sample temperature to freeze the cell sample(s), allowing the user to specify a multi-stage TemperatureProfile if desired. This can be set by FreezingStrategy option. Environmental data from temperature sensors in the freezer can be found in the FreezerEnvironmentalData field.
    PlotTable[{preparedVialsProtocol,addingCryoprotectantProtocol,changingMediaProtocol}, {Freezers[[1]][Model]}]
    If InsulatedCooler is selected, a FreezeCellsCoolantTransferProtocol is generated to specifying how to add coolant to insulated cooler.
    PlotTable[{preparedVialsProtocol,addingCryoprotectantProtocol,changingMediaProtocol}, FreezeCellsCoolantTransferProtocol]
    • Inspecting the video recording for transfer operations using aseptic techniques:
    PlotTable[
        {preparedVialsProtocol,addingCryoprotectantProtocol,changingMediaProtocol},
        FreezeCellsTransferProtocol[Subprotocols]
    ]
    The video streams of the FreezeCellsTransferProtocol show the transfer performed in the biosafety cabinet:
    WatchProtocol[Object[Protocol,Transfer,"Transfer subprotocol for existing Cryovials with Cryoprotectants"]]

Example Calls

    Freezing Cells

    Freeze a batch of cells using a controlled rate cell freezer instrument:
    Freeze a batch of cells using an insulated cooler:
    Distribute the contents of a cell sample across multiple cryogenic vials before freezing:
    Add a cryoprotectant to the cell samples before freezing:
    Pellet cell samples and exchange the existing media for a cryoprotectant before freezing:

Preferred Input Containers

    ExperimentFreezeCells accepts cryogenic vials for in situ sample preparation. Samples in other types of input containers are accepted, but must be transferred to cryogenic vials prior to the freezing step.
    When CryoprotectionStrategy is ChangeMedia, samples must be provided in centrifuge-compatible containers to allow pelleting.

Data Processing

    Extract and visualize the temperature profile recorded during the freezing process inside a controlled rate freezer:
    Extract and visualize the temperature data points recorded during the freezing process inside a static temperature freezer:

Warnings and Errors

    Messages  (107)

    CellPelletCentrifugeIsIncompatible  (2)

    If the specified centrifuge model is not compatible with the given container, an error is thrown:

    If the specified centrifuge model is not compatible with the specified CellPelletIntensity, an error is thrown:

    CellTypeNotSpecified  (1)

    If any input sample has no specified CellType and no information in the CellType field of the Object[Sample], the CellType defaults to Bacterial and a warning is thrown:

    ConflictingCellFreezingOptions  (3)

    If FreezingRack is set to a rack model for controlled rate freezer while Coolant is also specified, an error is thrown:

    If FreezingRack is set to both a controlled rate freezer rack and a Mr.Frosty rack, an error is thrown:

    If TemperatureProfile for ControlledRateFreezer is specified while CryogenicSampleContainer is set to a container whose MaxVolume is greater than 2 Milliliter, an error is thrown:

    ConflictingCellType  (2)

    If a CellType is specified for any sample which does not match the CellType field in Object[Sample] and conflicts with microbial/non-microbial, an error is thrown:

    If a microbial CellType is specified for any sample which does not match the microbial CellType field in Object[Sample], a warning is thrown:

    ConflictingChangeMediaOptionsForSameContainer  (1)

    If the samples in the same input sample container have ChangeMedia options (CellPelletCentrifuge,CellPelletIntensity,CellPelletTime), throw an error:

    ConflictingCryoprotectantSolutionTemperature  (1)

    If CryoprotectantSolutionTemperature is specified while CryoprotectionStrategy is None at all indices, a warning is thrown:

    ConflictingCryoprotectionOptions  (3)

    If specified options leading to different cryoprotection strategy for the same sample, throw an error:

    If the samples in the same input sample container, one of them has ChangeMedia specified while the other one resolves to other strategy, throw an error:

    If the samples in the same input sample container, one of them resolves to ChangeMedia while the other one resolves to other strategy, throw an error:

    ConflictingCultureAdhesion  (1)

    If a CultureAdhesion is specified for any sample which does not match the CultureAdhesion field in Object[Sample], an error is thrown:

    CryogenicVialAliquotingRequired  (2)

    Throw an error if ContainersIn is not a cryo vial but Aliquot is set to False:

    Throw an error if ContainersIn is not the same cryo vial as CryogenicSampleContainer but Aliquot is set to False:

    CryoprotectantSolutionOverfill  (3)

    If addition of CryoprotectantSolution would result in overfilling the cell sample's current container factoring in supernatant removal, an error is thrown:

    If the addition of CryoprotectantSolution would result in overfilling the cell sample's current container factoring in supernatant removal, an error is thrown:

    If the addition of CryoprotectantSolution would result in overfilling the cell sample's current container when Aliquot is False, an error is thrown:

    CultureAdhesionNotSpecified  (1)

    If any input sample has no specified CultureAdhesion and no information in the CultureAdhesion field of the Object[Sample], the CultureAdhesion defaults to Suspension and a warning is thrown:

    DeprecatedModel  (1)

    If the given samples have deprecated models, they cannot be incubated:

    DiscardedSample  (1)

    If the given samples are discarded, they cannot be incubated:

    EmptySamples  (2)

    If a sample is liquid but Volume is less than either 100 Microliter or 1% of container MaxVolume whichever is lower, throws a warning:

    If a sample is liquid but Volume is not populated, throws a warning:

    ExcessiveCryogenicSampleVolume  (1)

    If the total volume to be frozen for any cell sample exceeds the MaxVolume (5 Milliliter) of the largest cryogenic vial models, an error is thrown:

    FreezeCellsAliquotingRequired  (4)

    Throw a warning if ContainersIn has no model information, automatically set Aliquot to True:

    Throw a warning if ContainersIn is a 5ml cryo vial and FreezingStrategy is ControlledRateFreezer, automatically set Aliquot to True:

    Throw a warning if ContainersIn is not a cryo vial, automatically set Aliquot to True:

    Throw a warning if the volume of input sample with cryoprotectant solution is larger than 75% of max volume, automatically set Aliquot to True:

    FreezeCellsConflictingAliquotOptions  (2)

    If AliquotVolume is Null while Aliquot is True, an error is thrown:

    If AliquotVolume is specified while Aliquot is False, an error is thrown:

    FreezeCellsConflictingCoolant  (2)

    If Coolant is set to Null while FreezingStrategy is InsulatedCooler, an error is thrown:

    If Coolant is specified while FreezingStrategy is ControlledRateFreezer, an error is thrown:

    FreezeCellsConflictingHardware  (5)

    If CryogenicSampleContainer is set a 5 Milliliter container while FreezingStrategy is ControlledRateFreezer, an error is thrown:

    If Freezer is set to a controlled rate freezer model while FreezingStrategy is InsulatedCooler, an error is thrown:

    If Freezer is set to a static freezer model while FreezingStrategy is ControlledRateFreezer, an error is thrown:

    If FreezingRack is set to a controlled rate freezer rack model while FreezingStrategy is InsulatedCooler, an error is thrown:

    If FreezingRack is set to an insulated cooler rack model while FreezingStrategy is ControlledRateFreezer, an error is thrown:

    FreezeCellsConflictingInsulatedCoolerFreezingTime  (2)

    If InsulatedCoolerFreezingTime is set to Null while FreezingStrategy is InsulatedCooler, an error is thrown:

    If InsulatedCoolerFreezingTime is specified while FreezingStrategy is ControlledRateFreezer, an error is thrown:

    FreezeCellsConflictingTemperatureProfile  (2)

    If TemperatureProfile is set to Null while FreezingStrategy is ControlledRateFreezer, an error is thrown:

    If TemperatureProfile is specified while FreezingStrategy is InsulatedCooler, an error is thrown:

    FreezeCellsDuplicatedSamples  (7)

    Do not throw an error if all specified options are the same for two inputs which are expanded by framework while NumberOfReplicates is Null:

    Throws an error if all specified options are the same for two inputs which are identical while NumberOfReplicates is Null:

    Throws an error if both NumberOfReplicates and duplicated samples are manually selected:

    Throws an error if ChangeMedia CryoprotectionStrategies is applied to the input samples which are expanded by framework:

    Throws an error if multiple CryoprotectionStrategies including ChangeMedia is applied on the same input sample:

    Throws an error if the input samples are both expanded by framework and manually duplicated in input and associated with ChangeMedia:

    Throws an error if the number of appearance of the same sample with the same option is larger than NumberOfReplicates:

    FreezeCellsExtraneousChangeMediaOptions  (8)

    If CellPelletCentrifuge is specified while CryoprotectionStrategy is AddCryoprotectant, an error is thrown:

    If CellPelletCentrifuge is specified while CryoprotectionStrategy is None, an error is thrown:

    If CellPelletIntensity is specified while CryoprotectionStrategy is AddCryoprotectant, an error is thrown:

    If CellPelletIntensity is specified while CryoprotectionStrategy is None, an error is thrown:

    If CellPelletSupernatantVolume is specified while CryoprotectionStrategy is AddCryoprotectant, an error is thrown:

    If CellPelletSupernatantVolume is specified while CryoprotectionStrategy is None, an error is thrown:

    If CellPelletTime is specified while CryoprotectionStrategy is AddCryoprotectant, an error is thrown:

    If CellPelletTime is specified while CryoprotectionStrategy is None, an error is thrown:

    FreezeCellsExtraneousCryoprotectantOptions  (2)

    If CryoprotectantSolution is specified while CryoprotectionStrategy is None, an error is thrown:

    If CryoprotectantSolutionVolume is specified while CryoprotectionStrategy is None, an error is thrown:

    FreezeCellsInsufficientChangeMediaOptions  (7)

    If CellPelletCentrifuge is set to Null while CryoprotectionStrategy is ChangeMedia, an error is thrown:

    If CellPelletIntensity is set to Null while CryoprotectionStrategy is ChangeMedia, an error is thrown:

    If CellPelletSupernatantVolume is set to Null while CryoprotectionStrategy is ChangeMedia, an error is thrown:

    If CellPelletTime is set to Null while CryoprotectionStrategy is ChangeMedia, an error is thrown:

    If CryoprotectantSolution is set to Null while CryoprotectionStrategy is ChangeMedia, an error is thrown:

    If CryoprotectantSolutionTemperature is set to Null while CryoprotectionStrategy is ChangeMedia, an error is thrown:

    If CryoprotectantSolutionVolume is set to Null while CryoprotectionStrategy is ChangeMedia, an error is thrown:

    FreezeCellsInsufficientCryoprotectantOptions  (3)

    If CryoprotectantSolution is set to Null while CryoprotectionStrategy is AddCryoprotectant, an error is thrown:

    If CryoprotectantSolutionTemperature is set to Null while CryoprotectionStrategy is AddCryoprotectant, an error is thrown:

    If CryoprotectantSolutionVolume is set to Null while CryoprotectionStrategy is AddCryoprotectant, an error is thrown:

    FreezeCellsNoCompatibleCentrifuge  (2)

    If there is centrifuge model compatible with the given container, but out of range of CellPelletIntensity, an error is thrown:

    If there is no centrifuge model compatible with the given cell pelleting conditions, an error is thrown:

    FreezeCellsNonLiquidSamples  (1)

    If any input sample has a State other than Liquid, an error is thrown:

    FreezeCellsReplicateLabels  (2)

    If the NumberOfReplicates option is specified and CryogenicSampleContainerLabel is updated, a warning is thrown to tell the user how the CryogenicSampleContainerLabel expands to account for the replicates if we are calling MCP:

    If the NumberOfReplicates option is specified but CryogenicSampleContainerLabel is automatic, no warning is thrown to tell the user how the CryogenicSampleContainerLabel expands to account for the replicates:

    FreezeCellsReplicatesAliquotRequired  (1)

    If NumberOfReplicates is specified while Aliquot is False, an error is thrown:

    FreezeCellsUnsupportedTemperatureProfile  (3)

    If a specified TemperatureProfile involves a time specification that is less than the one that precedes it, an error is thrown:

    If a specified TemperatureProfile requires a cooling rate faster than 2 Celsius/Minute, an error is thrown:

    If a specified TemperatureProfile requires a nonzero cooling rate slower than 0.01 Celsius/Minute, an error is thrown:

    FreezeCellsUnusedSample  (4)

    If all of input cell sample is used factoring in duplicated samples, no warning is thrown:

    If a portion of input cell sample will not be frozen factoring in duplicated samples, a warning is thrown to indicate how much of the sample will not be frozen:

    If a portion of input cell sample will not be frozen factoring in duplicated samples, a warning is thrown to indicate how much of the sample will not be frozen:

    If a portion of input cell sample will not be frozen in the experiment due to aliquoting, a warning is thrown to indicate how much of the sample will not be frozen:

    InstrumentPrecision  (2)

    A warning is thrown if specified CellPelletIntensity has more digits than the allowed precision:

    TemperatureProfile temperature points may only be specified in increments of 1 Celsius:

    InsufficientVolumeForAliquoting  (3)

    If the AliquotVolume option is set to All while NumberOfReplicates is not Null, an error is thrown:

    If the specified AliquotVolume is greater than the amount of sample to be aliquoted, an error is thrown:

    If the total AliquotVolume option is more than sample volume, an error is thrown:

    InvalidChangeMediaSamples  (2)

    Do not throw an error if all samples in the input sample container have ChangeMedia:

    Throws an error if there are more samples in the input sample container while ChangeMedia is required:

    InvalidCryogenicSampleContainer  (3)

    If a specified CryogenicSampleContainer does not have a CEVial Footprint, an error is thrown:

    If a specified CryogenicSampleContainer does not have MinTemperature below -170C or contains glass, an error is thrown:

    If a specified CryogenicSampleContainer has only Snap CoverType, an error is thrown:

    InvalidFreezerModel  (1)

    If any Model[Instrument, Freezer] is specified for the Freezer option which does not have a DefaultTemperature within 5 Celsius of either -20 Celsius or -80 Celsius, an error is thrown:

    InvalidFreezingRack  (2)

    If a specified FreezingRack is not a rack for cryogenic samples, an error is thrown:

    If FreezingRack is set to a rack model appropriate for a 2 Milliliter CryogenicSampleContainer while CryogenicSampleContainer is set to a container whose MaxVolume is greater than 2 Milliliter, an error is thrown:

    ObjectDoesNotExist  (6)

    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:

    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):

    SupernatantOveraspiratedTransfer  (1)

    If CellPelletSupernatantVolume is larger than sample volume, an error is thrown:

    TooManyControlledRateFreezerBatches  (1)

    If an experiment is submitted with a FreezingStrategy of ControlledRateFreezer which requires multiple freezing batches because more than 48 samples will be frozen, an error is thrown:

    TooManyInsulatedCoolerBatches  (2)

    If an experiment is submitted with a FreezingStrategy of InsulatedCooler which requires more than three freezing batches because more than three different freezing conditions are required, an error is thrown:

    If an experiment is submitted with a FreezingStrategy of InsulatedCooler which requires more than three freezing batches because the number of samples to be frozen require more than the capacity of three FreezingRacks, an error is thrown:

    UnsupportedCellCultureType  (1)

    If any input sample has a CultureAdhesion other than Suspension, an error is thrown:

    UnsupportedCellTypes  (1)

    If any input sample has a CellType other than those currently supported (Mammalian, Bacterial, and Yeast), an error is thrown:

Possible Issues

    Batching Limitations

    Protocols with multiple input samples (or Protocols which use the NumberOfReplicates option to distribute a sample across multiple cryogenic vials) separate the samples into batches based on the experimental conditions. Due to hardware constraints and the time sensitive nature of the experiment, the number of batches permitted per protocol is limited. Protocols employing a controlled rate freezer are limited to one batch with a maximum of 48 samples, which is the capacity of the VIA Freeze Research instrument. Protocols employing insulated coolers are limited to three total batches, where each batch corresponds to a unique freezing rack.

    Container Constraints

    The VIA Freeze Research controlled rate freezer supports cryogenic vials up to 2 mL in volume, while the insulated cooler racks support vials up to 5 mL. To accommodate larger input volumes, the NumberOfReplicates option can be used to distribute the input sample across multiple cryogenic vials. Alternatively, the CryoprotectionStrategy may be set to ChangeMedia to pellet the cells, aspirate the existing media, and replace it with a smaller volume of cryoprotectant. Note that the sample containers must be centrifuge-compatible to enable pelleting.

    Culture Adhesions

    The current version of ExperimentFreezeCells does not support freezing of adherent cells or solid media samples.

    Compatible Freezers

    For InsulatedCooler protocols, only Freezers with temperatures of approximately -80 Celsius or -20 Celsius are supported.
Last modified on Tue 16 Sep 2025 07:18:22