Docs: Checkpoints Backends

Adds additional details on the IO backends in docs and tbg macros.
ComputationalRadiationPhysics · Nov 14, 2017 · 65b7618 · 65b7618
1 parent 9885479
commit 65b7618
Show file tree

Hide file tree

Showing 2 changed files with 29 additions and 14 deletions.
diff --git a/docs/TBG_macros.cfg b/docs/TBG_macros.cfg
@@ -187,9 +187,15 @@ TBG_adios="--adios.period 100 --adios.file simData"
 # Create a checkpoint that is restartable every --checkpoint.period steps
 #   http://git.io/PToFYg
 TBG_checkpoint="--checkpoint.period 1000"
+# Select the backend for the checkpoint, available are hdf5 and adios
+#    --checkpoint.backend adios
+#                         hdf5
 
 # Restart the simulation from checkpoint created using TBG_checkpoint
 TBG_restart="--checkpoint.restart"
+# Select the backend for the restart (must fit the created checkpoint)
+#    --checkpoint.restart.backend adios
+#                                 hdf5
 # By default, the last checkpoint is restarted if not specified via
 #   --checkpoint.restart.step 1000
 # To restart in a new run directory point to the old run where to start from

diff --git a/docs/source/usage/plugins/checkpoint.rst b/docs/source/usage/plugins/checkpoint.rst
@@ -34,20 +34,29 @@ The plugin is available as soon as the :ref:`libSplash (HDF5) or ADIOS libraries
 You can use ``--checkpoint.period`` to specify the output period of the created checkpoints.
 Note that this plugin will only be available if libSplash (HDF5) or ADIOS is found during compile configuration.
 
-================================== ======================================================================================
-PIConGPU command line option       Description
-================================== ======================================================================================
-``--checkpoint.backend``           IO-backend used to create the checkpoint.
-``--checkpoint.file``              Relative or absolute fileset prefix for writing checkpoints.
-                                   If relative, checkpoint files are stored under ``simOutput/<checkpoint-directory>``.
-                                   Default depends on the selected IO-backend.
-``--checkpoint.restart.backend``   IO-backend used to load a existent checkpoint.
-``--checkpoint.restart.file``      Relative or absolute fileset prefix for reading checkpoints.
-                                   If relative, checkpoint files are searched under ``simOutput/<checkpoint-directory>``.
-                                   Default depends on the selected IO-backend``.
-``--checkpoint.restart.chunkSize`` Number of particles processed in one kernel call during restart to prevent frame count blowup.
-``--checkpoint.<IO-backend>.*      Additional options to control the IO-backend
-================================== ======================================================================================
+============================================= ======================================================================================
+PIConGPU command line option                  Description
+============================================= ======================================================================================
+``--checkpoint.period <N>``                   Create checkpoints every N steps.
+``--checkpoint.backend <IO-backend>``         IO-backend used to create the checkpoint.
+``--checkpoint.file <string>``                Relative or absolute fileset prefix for writing checkpoints.
+                                              If relative, checkpoint files are stored under ``simOutput/<checkpoint-directory>``.
+                                              Default depends on the selected IO-backend.
+``--checkpoint.restart``                      Restart a simulation from the latest checkpoint.
+``--checkpoint.restart.step <N>``             Select a specific restart checkpoint.
+``--checkpoint.restart.backend <IO-backend>`` IO-backend used to load a existent checkpoint.
+``--checkpoint.restart.file <string>``        Relative or absolute fileset prefix for reading checkpoints.
+                                              If relative, checkpoint files are searched under ``simOutput/<checkpoint-directory>``.
+                                              Default depends on the selected IO-backend``.
+``--checkpoint.restart.chunkSize <N>``        Number of particles processed in one kernel call during restart to prevent frame count
+                                              blowup.
+``--checkpoint.<IO-backend>.*``               Additional options to control the IO-backend
+============================================= ======================================================================================
+
+Depending on the available external dependencies (see above), the options for the ``<IO-backend>`` are:
+
+* ``hdf5``
+* ``adios``
 
 Interacting Manually with Checkpoint Data
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^