Simple Programs

In this section we show some example implementations of the OAQ specification for some core concepts.

Defining a Port

Ports are defined simply with a Port node and an ID value. Valid values for Ports should be declared in the backend documentation.

In this example a Port with an ID "100" is declared.

Note

Since the tree below doesn't start with a Job node it is not by itself a valid AST, and is just meant as an example of declaring a Port.

Tree format:

graph TD
    NumericLiteral1["100"]
    Port1["Port"]
    Port1 -- "Id" --- NumericLiteral1

Defining a Frame

A frame is defined by a frequency, phase and a Port the frame is to be played on. Optionally, an intermediate frequency can be specified to force that to be used by the backend.

In this example, a Frame of frequency 5 GHz and zero initial phase applied to port "100" is defined. Additionally an IF of 100 MHz is specified.

Note

Since the tree below does't start with a Job node it is not by itself a valid AST, and is just meant as an example of declaring a Frame.

Tree format:

graph TD
    NumericLiteral1["100"]
    Port1["Port"]
    Port1 -- "Id" --- NumericLiteral1

    Frequency1["5 GHz"]
    Radians2["0 rad"]
    Frequency3["10 MHz"]
    Frame1["Frame"]
    Frame1 -- "Port" --- Port1
    Frame1 -- "Frequency" --- Frequency1
    Frame1 -- "Phase" --- Radians2
    Frame1 -- "IntermediateFrequency" --- Frequency3

A single unmodulated pulse

In this example we declare a very simple job that consists of a single unmodulated Gaussian pulse to be played on port "100".

Example schedule

Tree format:

graph TD
    NumericLiteral1["100"]
    Port1["Port"]
    Port1 -- "Id" --- NumericLiteral1

    Interval1["50 ns"]
    Interval2["10 ns"]
    Waveform1["GaussianWaveform"]
    Waveform1 -- "Duration" --- Interval1
    Waveform1 -- "Sigma" --- Interval2

    NumericLiteral2["0.5"]
    Amplitude3["Amplitude"]
    Amplitude3 -- "Value" --- NumericLiteral2

    Instruction1["UnmodulatedPulse"]
    Instruction1 -- "Port" --- Port1
    Instruction1 -- "Envelope" --- Waveform1
    Instruction1 -- "Amplitude" --- Amplitude3

JSON format:

Job definition

{
    "version": "0.1.0",
    "compatible_version": "0.1.0",
    "entry_point": [
        {
            "$type": "UnmodulatedPulse",
            "port": {
                "id": {
                    "$type": "NumericLiteral",
                    "value": 100
                }
            },
            "envelope": {
                "$type": "GaussianWaveform",
                "duration": {
                    "$type": "NumericLiteral",
                    "value": 5E-08
                },
                "sigma": {
                    "$type": "NumericLiteral",
                    "value": 1E-08
                }
            },
            "amplitude": {
                "$type": "NumericLiteral",
                "value": 0.5
            }
        }
    ]
}

A single modulated pulse

In this example we declare a job that consists of a modulated constant waveform played on the frame defined earlier.

Example schedule

Tree format:

graph TD
    NumericLiteral1["100"]
    Port1["Port"]
    Port1 -- "Id" --- NumericLiteral1

    Frequency1["5 GHz"]
    Radians2["0 rad"]
    Frequency3["10 MHz"]
    Frame1["Frame"]
    Frame1 -- "Port" --- Port1
    Frame1 -- "Frequency" --- Frequency1
    Frame1 -- "Phase" --- Radians2
    Frame1 -- "IntermediateFrequency" --- Frequency3

    Interval4["100 ns"]
    Waveform1["ConstantWaveform"]
    Waveform1 -- "Duration" --- Interval4

    Instruction1["ModulatedPulse"]
    Instruction1 -- "Frame" --- Frame1
    Instruction1 -- "Envelope" --- Waveform1

    NumericLiteral2["0.5"]
    Amplitude5["Amplitude"]
    Amplitude5 -- "Value" --- NumericLiteral2
    Instruction1 -- "Amplitude" --- Amplitude5

JSON format:

Job definition

{
    "version": "0.1.0",
    "compatible_version": "0.1.0",
    "entry_point": [
        {
            "$type": "ModulatedPulse",
            "frame": {
                "port": {
                    "id": {
                        "$type": "NumericLiteral",
                        "value": 100
                    }
                },
                "frequency": {
                    "$type": "NumericLiteral",
                    "value": 5000000000
                },
                "phase": {
                    "$type": "NumericLiteral",
                    "value": 0
                },
                "intermediate_frequency": {
                    "$type": "NumericLiteral",
                    "value": 10000000
                }
            },
            "envelope": {
                "$type": "ConstantWaveform",
                "duration": {
                    "$type": "NumericLiteral",
                    "value": 1E-07
                }
            },
            "phase_offset": {
                "$type": "NumericLiteral",
                "value": 0
            },
            "amplitude": {
                "$type": "NumericLiteral",
                "value": 0.5
            }
        }
    ]
}