Project Directory Structure - crt26/pqc-evaluation-tools GitHub Wiki

Repository Directory Structure

This document outlines the directory structure of the PQC-Evaluation-Tools repository. It includes both the default contents available upon cloning and the directories that are dynamically generated during operation.

Directories created by scripts during execution are marked with an asterisk (*) in the directory layout diagram.

Layout and Descriptions

The PQC-Evaluation-Tools repository directories are organised as follows:

pqc-evaluation-tools/
│
├── docs
|   └── developer-information
│   └── testing-tools-documentation
│
├── lib*
│
├── modded-lib-files
│
├── scripts
│   ├── parsing-scripts
│   ├── utility-scripts
│   └── test-scripts
│
└── test-data
    ├── alg-lists*
    ├── results*
    └── up-results*

Directory Descriptions

Name	Subdirectory	Auto-Generated	Description
docs			Contains documentation files related to the project.
developer-information	*		Internal notes and references for project development.
testing-tools-documentation	*		Guides and usage docs for the automated testing tools.
lib		*	Populated during setup; contains libraries used for performance testing, including Liboqs, OQS-Provider, OpenSSL, and Pqax.
modded-lib-files			Contains modified files from the OQS project, adapted for this repository’s functionality.
scripts			Contains core scripts used throughout the project.
parsing-scripts	*		Scripts for parsing raw benchmarking output from test-data/up-results.
test-scripts	*		Scripts for running performance and correctness tests.
utility-scripts	*		Utility scripts used by users and automated testing routines.
test-data			Contains input and output data used by the testing framework.
alg-lists	*	*	Generated during setup; contains text files listing PQC algorithms supported by the installed OQS libraries.
results	*	*	Contains parsed benchmarking results, processed and formatted by the parsing scripts.
up-results	*	*	Stores raw, unparsed benchmarking output generated by the testing scripts.