From 1696025974145ea7e44c473aa151c4798662f268 Mon Sep 17 00:00:00 2001 From: Bogdan Nicolae Date: Tue, 1 Oct 2019 01:55:03 -0500 Subject: [PATCH] Updated documentation to add non-collective mode --- docs/api.rst | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/docs/api.rst b/docs/api.rst index 919592b..8e48a9c 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -45,7 +45,25 @@ ARGUMENTS DESCRIPTION ''''''''''' -This function initializes the VELOC library. It must be called collectively by all processes before any other VELOC function. A good practice is to call it immediately after ``MPI_Init()``. +This function initializes the VELOC library. It must be called collectively by all processes before any other VELOC function. A good practice is to call it immediately after ``MPI_Init()``. + +Non-collective initialization +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +:: + + int VELOC_Init_single(unsigned int unique_id, IN const char *cfg_file) + +ARGUMENTS +''''''''' + +- **unique_id**: A unique identifier of the process that needs to checkpoint individually +- **cfg_file**: The VeloC configuration file, detailed in the user guide. + +DESCRIPTION +''''''''''' + +This function initializes the VELOC library in non-collective mode, which enables each process to checkpoint and restart independently of the other processes. Notably, this will impact the behavior of ``VELOC_Restart_test`` (detailed below), which will return the latest version available for the calling process, rather than the whole group. Finalize ^^^^^^^^