Flow file YAML schema reference¶
The following pages provide a comprehensive reference to the syntax used by the Qruise flow files. They’re not intended as an introduction to running and customising workflows. If you want to learn more about this, you can take a look at our Running a workflow guide.
The starting point for this reference is the flow object.
How to use this guide¶
Each page of this reference documents a data type that can be used in a flow file, with all the fields explained. For brevity, we use Python-type annotations from the typing module. If you’re already a Python user you’re most likely already familiar with these, but they’re close enough to human language that you should have no problems understanding them, even if you have never used Python before.
On each page you’ll find a YAML snippet for a data type, containing all the keys a particular object can have, with the values specifying the field type. For instance, the snippet for the flow object has the following form:
name: str
schedules: List[cronSchedule] | None
qubits: List[str]
couplings: List[Tuple[str, str]]
stages: stages
batch_groups: List[batchGroup] | None
As you can see, the field name must be a string, while qubits is an optional field and accepts a list of strings. You can use these snippets to create new flow files with minimal effort.