README.md

scaflow: dataflow-based side-channel analysis

Acting as a component part of the wider SCARV project, scaflow is framework, and suite of associated tools, which allow expression of side-channel analysis flows as dataflow programs, and execution of those flows, where appropriate offloading computation to suitable resources.

Organisation

├── bin                     - scripts (e.g., environment configuration)
├── build                   - working directory for build
└── src
    └── scaflow             - source code for scaflow

Quickstart

1. Install any associated pre-requisites, e.g.,

   • a Python 3 distribution,
   • the Doxygen documentation generation system.

2. Execute

   git clone https://github.com/scarv/scaflow.git ./scaflow
   cd ./scaflow
   git submodule update --init --recursive
   source ./bin/conf.sh

   to clone and initialise the repository, then configure the environment; for example, you should find that the environment variable REPO_HOME is set appropriately.

3. Use targets in the top-level Makefile to drive a set of common tasks, e.g.,

   Command	Description
   make venv	build the Python virtual environment
   make doxygen	build the Doxygen-based documentation
   make spotless	remove everything built in ${REPO_HOME}/build

Questions?

• read the wiki,
• raise an issue,
• raise a pull request,
• drop us an email.

Acknowledgements

This work has been supported in part by EPSRC via grant EP/R012288/1 (under the RISE programme).