Libraries, Recipes, Setups, and Layouts
-
Q: What is a Library?
A: A Library is a collection of related Python classes and methods. Libraries are intended to allow for reuse of common functionality across multiple Recipes.
-
Q: How do I upload or delete a Library?
A: Use the Library page on the Dashboard to upload or delete a Library. See complete instructions here.
-
Q: What is a Recipe Script?
A: A Recipe Script is simply a Python file (
.py
) that is run in the Aqueduct environment. It contains the logic to execute your process. A Recipe Script can import from one or more local Libraries and the standard Python library. -
Q: What is a Recipe file?
A: A Recipe file (
.recipe
extension) contains a Recipe Script, a Setup, and (optionally) a Layout. It contains all of the data necessary to recreate a user interface (Device, Container, and Connection icon arrangement and Widget layout and metadata) and the logic (contained in the Recipe Script) to execute a protocol or processs. -
Q: What is a Setup file?
A: A Setup file (
.setup
extension) contains the type and number of:- Devices: pumps, valves, sensors, or other hardware that has I/O
- Containers: beakers, vials, or other 'passive' labware
- Connections: representations of tubing, both external and internal to Devices or Containers
A Setup also contains the position and orientation data of the icons used to generate the user interface.
-
Q: What is a Layout file?
A: A Layout file (
.layout
extension) contains the Widget metadata that generates the user interface. For instance, the specific data series plotted on a Chart Widget on Tab 1 is stored in a Layout file. You can tailor the Layout arrangement to your preferences and save the configuration as a Layout file for reuse later.