Skip to content

Commit

Permalink
edits to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
gonsie committed Sep 26, 2017
1 parent ecbfc15 commit 275567e
Showing 1 changed file with 15 additions and 13 deletions.
28 changes: 15 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,18 @@

VELOC software version 0.5

The VELOC project aims to provide a framework offering a checkpoint/restart interface and providing transparently the benefit of multilevel checkpointing to exascale applications. VELOC is a collaboration between Argonne National Laboratory and Lawrence Livermore National Laboratory as part of the Exascale Computing Project.

The VELOC project aims to provide a framework offering a checkpoint/restart interface and providing transparently the benefit of multilevel checkpointing to exascale applications.
VELOC is a collaboration between Argonne National Laboratory and Lawrence Livermore National Laboratory as part of the Exascale Computing Project.

## VELOC API

This implementation of VELOC software is based on VELOC API (version 0.4 currently).The VELOC API can be obtained from the https://xgitlab.cels.anl.gov/ecp-veloc/Veloc-Documentation.git
This implementation of VELOC software is based on VELOC API.
The VELOC API can be obtained from the https://xgitlab.cels.anl.gov/ecp-veloc/Veloc-Documentation.git

## Project Setup

Current VELOC software (veloc-0.5) implements the VELOC API in the VELOC client layer library and for now uses SCR as the VELOC backend. The software has scripts in place to download and builds the current version SCR.

Current VELOC software (veloc-0.5) implements the VELOC API in the VELOC client layer library and for now uses SCR as the VELOC backend.
The software has scripts in place to download and builds the current version SCR.

## Quickstart

Expand All @@ -32,6 +33,7 @@ make test
```

### SCR Build Error

Note that currently, SCR requires the PDSH library.
To automatically download and build PDSH as part of the CMake build, use the option `-DBUILD_PDSH=ON` when configuring CMake.

Expand All @@ -45,18 +47,18 @@ We currently test three ways to interact with the VeloC API:

The tests can be run using `make test` or, for more verbose output, using `make check`.

The test directory contains a few examples showcasing the different features of VELOC. It contains three variants of an example program which implementsa distributed heat equation calculation. These three examples use of both memory protection and file protection mechanisms.
The test directory contains a few examples showcasing the different features of VELOC.
It contains three variants of an example program which implements a distributed heat equation calculation.
These three examples use of both memory protection and file protection mechanisms.

1. heatdis_mem.c shows how to use VELOC if you are using only memory-based checkpointing. The variables in the code are memory protected and used during checkpointing/recovery
1. heatdis_mem.c shows how to use VELOC if you are using only memory-based checkpointing.
The variables in the code are memory protected and used during checkpointing/recovery

2. heatdis_file.c shows how to use VELOC if you are only using file-based checkpointing. The variables in the code are written to files and used during checkpointing/recovery
2. heatdis_file.c shows how to use VELOC if you are only using file-based checkpointing.
The variables in the code are written to files and used during checkpointing/recovery

3. heatdis_memfile.c shows how to use VELOC when you memory-protecting some variables and writing some to files


## Contacts
In case of questions and comments or help, please contact the VELOC team at ecp-veloc@lists.mcs.anl.gov




In case of questions and comments or help, please contact the VELOC team at ecp-veloc@lists.mcs.anl.gov

0 comments on commit 275567e

Please sign in to comment.