pylabrobot.thermocycling.thermocycler.Thermocycler#

class pylabrobot.thermocycling.thermocycler.Thermocycler(name: str, size_x: float, size_y: float, size_z: float, backend: ThermocyclerBackend, child_location: Coordinate, category: str = 'thermocycler', model: str | None = None)#

Bases: ResourceHolder, Machine

Generic Thermocycler: block + lid + profile + status queries.

Attributes

name

Get the name of this resource.

resource

setup_finished

Methods

__init__(name, size_x, size_y, size_z, ...)

Initialize a Thermocycler resource.

assign_child_resource(resource[, location, ...])

Assign a child resource to this resource.

at(location)

Return a copy of this resource at the given location.

center([x, y, z])

Get the center of this resource.

centers([xn, yn, zn])

Get equally spaced points in the x, y, and z directions.

close_lid(**backend_kwargs)

copy()

deactivate_block(**backend_kwargs)

Turn off the block heater.

deactivate_lid(**backend_kwargs)

Turn off the lid heater.

deregister_did_assign_resource_callback(callback)

Remove a callback that will be called after a resource is assigned to this resource.

deregister_did_unassign_resource_callback(...)

Remove a callback that will be called after a resource is unassigned from this resource.

deregister_state_update_callback(callback)

Remove a callback that will be called when the state of the resource changes.

deregister_will_assign_resource_callback(...)

Remove a callback that will be called before a resource is assigned to this resource.

deregister_will_unassign_resource_callback(...)

Remove a callback that will be called before a resource is unassigned from this resource.

deserialize(data[, allow_marshal])

Deserialize a resource from a dictionary.

get_absolute_location([x, y, z])

Get the absolute location of this resource, probably within the pylabrobot.resources.Deck.

get_absolute_rotation()

Get the absolute rotation of this resource.

get_absolute_size_x()

Get the absolute size in the x direction.

get_absolute_size_y()

Get the absolute size in the y direction.

get_absolute_size_z()

Get the absolute size in the z direction.

get_all_children()

Recursively get all children of this resource.

get_anchor([x, y, z])

Get a relative location within the resource.

get_block_current_temperature(**backend_kwargs)

Get the current block temperature(s) (°C).

get_block_status(**backend_kwargs)

Get the block status.

get_block_target_temperature(**backend_kwargs)

Get the block's target temperature(s) (°C).

get_current_cycle_index(**backend_kwargs)

Get the one-based index of the current cycle.

get_current_step_index(**backend_kwargs)

Get the one-based index of the current step.

get_default_child_location(resource)

get_highest_known_point()

Recursively finds the highest known point in absolute space.

get_hold_time(**backend_kwargs)

Get remaining hold time (s) for the current step.

get_lid_current_temperature(**backend_kwargs)

Get the current lid temperature(s) (°C).

get_lid_open(**backend_kwargs)

Return True if the lid is open.

get_lid_status(**backend_kwargs)

Get the lid temperature status.

get_lid_target_temperature(**backend_kwargs)

Get the lid's target temperature(s) (°C), if supported.

get_resource(name)

Get a resource by name.

get_root()

Get the root of the resource tree.

get_size_x()

Local size in the x direction.

get_size_y()

Local size in the y direction.

get_size_z()

Local size in the z direction.

get_total_cycle_count(**backend_kwargs)

Get the total number of cycles.

get_total_step_count(**backend_kwargs)

Get the total number of steps in the current cycle.

is_in_subtree_of(other)

Return True if self is in the subtree rooted at other.

is_profile_running(**backend_kwargs)

Return True if a profile is still in progress.

load_all_state(state)

Load state for this resource and all children.

load_from_json_file(json_file)

Loads resources from a JSON file.

load_state(state)

Load state for this resource only.

load_state_from_file(fn)

Load the state of this resource and all children from a JSON file.

open_lid(**backend_kwargs)

register_did_assign_resource_callback(callback)

Add a callback that will be called after a resource is assigned to this resource.

register_did_unassign_resource_callback(callback)

Add a callback that will be called after a resource is unassigned from this resource.

register_state_update_callback(callback)

Register a callback that will be called when the state of the resource changes.

register_will_assign_resource_callback(callback)

Add a callback that will be called before a resource is assigned to this resource.

register_will_unassign_resource_callback(...)

Add a callback that will be called before a resource is unassigned from this resource.

rotate([x, y, z])

Rotate counter-clockwise by the given number of degrees.

rotated([x, y, z])

Return a copy of this resource rotated by the given number of degrees.

run_pcr_profile(denaturation_temp, ...[, ...])

Run a PCR profile with specified parameters.

run_protocol(protocol, block_max_volume, ...)

Enqueue a multi-stage temperature protocol (fire-and-forget).

save(fn[, indent])

Save a resource to a JSON file.

save_state_to_file(fn[, indent])

Save the state of this resource and all children to a JSON file.

serialize()

JSON-serializable representation.

serialize_all_state()

Serialize the state of this resource and all children.

serialize_state()

Serialize the state of this resource only.

set_block_temperature(temperature, ...)

Set the block temperature.

set_lid_temperature(temperature, ...)

Set the lid temperature.

setup(**backend_kwargs)

stop()

unassign()

Unassign this resource from its parent.

unassign_child_resource(resource)

Unassign a child resource from this resource.

wait_for_block([timeout, tolerance])

Wait until block temp reaches target ± tolerance for all zones.

wait_for_lid([timeout, tolerance])

Wait until the lid temperature reaches target ± tolerance or the lid temperature status is idle/holding at target.

wait_for_profile_completion([poll_interval])

Block until the profile finishes, polling at poll_interval seconds.
Parameters: