flow

This module allows to execute hwpwn commands that are written in a YAML file. This is different from executing multiple hwpwn commands in chain in the console.

The flow file structure is the following:

---
options:
  scale: <number, i.e., 1e-6>
  ts: <number, i.e., 4e-9>
  description: |
    <A multiline description of this flow.
    Second line comes here.>
operations:
  - data.load:
      filepath: my_data.csv.gz
  - plot.time:
  - flow.exit:

The options has three possible attributes: the scale, the ts, and the description. The operations is the list of steps to be executed. These are run in sequence. They are specified with the notation <module_name>.<function_name>.

This essentially allows to execute any command from the modules, from the flow file.

Hint

Refer to the quickstart section for more examples of usage of this command.

hwpwn.flow.run(filepath: str)

Runs a specific flow stored in the file specified by filepath parameter.

Parameters:

filepath – Path to the flow to be executed. This file is expected to be in YAML format.

hwpwn.flow.exit()

Terminates the execution of the flow.