Skip to content

ECP-VeloC/component-user-docs

Repository files navigation

Component User Documentation

This site documents user-facing APIs for each of ECP-VELOC components. This documentation comes in the form of header files. Most components can be used with only a single #include of the main header file. However, for some components, additional functionality and utilities are provided in other headers.

These components were originally designed as part of the Scalable Checkpoint/Restart (SCR) library. For more details, read the veloc user documentation.

Components Diagram

Component Version GitHub GitHub Actions
KVTree ? GH Build&Test
AXL ? GH Build Only
SPath ? GH Build&Test
Shuffile ? GH Build Only
Redset ? GH Build Only
Rankstr ? GH Build&Test
ER ? GH Build Only