riverine.echo

riverine.echo#

Attributes#

DEFAULT_DROPLET_VOL

Classes#

`AbstractEchoAction`	Abstract base class for Echo actions.
`EchoFixedVolume`	Transfer a fixed volume of liquid to a target mix.
`EchoEqualTargetConcentration`	Transfer a fixed volume of liquid to a target mix.
`EchoTargetConcentration`	Get as close as possible (using direct transfers) to a target concentration, possibly varying mix volume.
`EchoFillToVolume`	Abstract base class for Echo actions.

Module Contents#

riverine.echo.DEFAULT_DROPLET_VOL[source]#

class riverine.echo.AbstractEchoAction[source]#

Bases: riverine.actions.ActionWithComponents

Abstract base class for Echo actions.

to_picklist(mix: riverine.mixes.Mix, experiment: riverine.experiments.Experiment | None = None, _cache_key=None) → kithairon.picklists.PickList[source]#

class riverine.echo.EchoFixedVolume[source]#

Bases: AbstractEchoAction

Transfer a fixed volume of liquid to a target mix.

fixed_volume: riverine.units.DecimalQuantity[source]#

set_name: str | None = None[source]#

droplet_volume: riverine.units.DecimalQuantity[source]#

compact_display: bool = True[source]#

_check_volume() → None[source]#

dest_concentrations(mix_vol: riverine.units.DecimalQuantity = NAN_VOL, actions: Sequence[riverine.actions.AbstractAction] = (), _cache_key=None) → list[riverine.units.DecimalQuantity][source]#

each_volumes(mix_volume: riverine.units.DecimalQuantity = NAN_VOL, actions: Sequence[riverine.actions.AbstractAction] = (), _cache_key=None) → list[riverine.units.DecimalQuantity][source]#

property name: str[source]#

_mixlines(tablefmt: str | tabulate.TableFormat, mix_vol: riverine.units.DecimalQuantity, actions: Sequence[riverine.actions.AbstractAction] = (), _cache_key=None) → list[riverine.printing.MixLine][source]#

mix_volume_effect(_cache_key=None)[source]#

The effect of the action on the mix volume.

Returns:

MixVolumeDep – How the mix volume affects the action.
DecimalQuantity – If MixVolumeDep is DETERMINES, the total mix volume that the action causes. If MixVolumeDep is DEPENDS, NAN. If MixVolumeDep is INDEPENDENT, the total volume that the action adds.

class riverine.echo.EchoEqualTargetConcentration[source]#

Bases: AbstractEchoAction

Transfer a fixed volume of liquid to a target mix.

fixed_volume: riverine.units.DecimalQuantity[source]#

set_name: str | None = None[source]#

droplet_volume: riverine.units.DecimalQuantity[source]#

compact_display: bool = False[source]#

method: Literal['max_volume', 'min_volume', 'check'] | tuple[Literal['max_fill'], str] = 'min_volume'[source]#

_check_volume() → None[source]#

dest_concentrations(mix_vol: riverine.units.DecimalQuantity = NAN_VOL, actions: Sequence[riverine.actions.AbstractAction] = (), _cache_key=None) → list[riverine.units.DecimalQuantity][source]#

each_volumes(mix_volume: riverine.units.DecimalQuantity = NAN_VOL, actions: Sequence[riverine.actions.AbstractAction] = (), _cache_key=None) → list[riverine.units.DecimalQuantity][source]#

property name: str[source]#

_mixlines(tablefmt: str | tabulate.TableFormat, mix_vol: riverine.units.DecimalQuantity, actions: Sequence[riverine.actions.AbstractAction] = (), _cache_key=None) → list[riverine.printing.MixLine][source]#

mix_volume_effect(_cache_key=None)[source]#

The effect of the action on the mix volume.

Returns:

MixVolumeDep – How the mix volume affects the action.
DecimalQuantity – If MixVolumeDep is DETERMINES, the total mix volume that the action causes. If MixVolumeDep is DEPENDS, NAN. If MixVolumeDep is INDEPENDENT, the total volume that the action adds.

class riverine.echo.EchoTargetConcentration[source]#

Bases: AbstractEchoAction

Get as close as possible (using direct transfers) to a target concentration, possibly varying mix volume.

target_concentration: riverine.units.DecimalQuantity[source]#

set_name: str | None = None[source]#

droplet_volume: riverine.units.DecimalQuantity[source]#

compact_display: bool = True[source]#

dest_concentrations(mix_vol: riverine.units.DecimalQuantity = NAN_VOL, actions: Sequence[riverine.actions.AbstractAction] = (), _cache_key=None) → list[riverine.units.DecimalQuantity][source]#

each_volumes(mix_volume: riverine.units.DecimalQuantity = NAN_VOL, actions: Sequence[riverine.actions.AbstractAction] = (), _cache_key=None) → list[riverine.units.DecimalQuantity][source]#

_mixlines(tablefmt: str | tabulate.TableFormat, mix_vol: riverine.units.DecimalQuantity, actions: Sequence[riverine.actions.AbstractAction] = (), _cache_key=None) → list[riverine.printing.MixLine][source]#

property name: str[source]#

mix_volume_effect(_cache_key=None)[source]#

The effect of the action on the mix volume.

Returns:

MixVolumeDep – How the mix volume affects the action.
DecimalQuantity – If MixVolumeDep is DETERMINES, the total mix volume that the action causes. If MixVolumeDep is DEPENDS, NAN. If MixVolumeDep is INDEPENDENT, the total volume that the action adds.

class riverine.echo.EchoFillToVolume[source]#

Bases: AbstractEchoAction

Abstract base class for Echo actions.

target_total_volume: riverine.units.DecimalQuantity[source]#

droplet_volume: riverine.units.DecimalQuantity[source]#

dest_concentrations(mix_vol: riverine.units.DecimalQuantity = NAN_VOL, actions: Sequence[riverine.actions.AbstractAction] = (), _cache_key=None) → list[riverine.units.DecimalQuantity][source]#

each_volumes(mix_volume: riverine.units.DecimalQuantity = NAN_VOL, actions: Sequence[riverine.actions.AbstractAction] = (), _cache_key=None) → list[riverine.units.DecimalQuantity][source]#

_mixlines(tablefmt: str | tabulate.TableFormat, mix_vol: riverine.units.DecimalQuantity, actions: Sequence[riverine.actions.AbstractAction] = (), _cache_key=None) → list[riverine.printing.MixLine][source]#

mix_volume_effect(_cache_key=None)[source]#

The effect of the action on the mix volume.

Returns:

MixVolumeDep – How the mix volume affects the action.
DecimalQuantity – If MixVolumeDep is DETERMINES, the total mix volume that the action causes. If MixVolumeDep is DEPENDS, NAN. If MixVolumeDep is INDEPENDENT, the total volume that the action adds.