diff --git a/docs/executables/tools.rst b/docs/executables/tools.rst index f8aab0fa354031ac49ea45df33650eefb897d6e8..ce3c9b70f38af0ba18cbe66c59e3f61518a41313 100644 --- a/docs/executables/tools.rst +++ b/docs/executables/tools.rst @@ -1,3 +1,88 @@ Executables =========== +- ``frontend/GenericIOPrint`` print data to stdout (non-MPI version) +- ``frontend/GenericIOVerify`` verify and try reading data (non-MPI version) +- ``mpi/GenericIOPrint`` print data to stdout +- ``mpi/GenericIORewrite`` rewrite data with a different number of ranks +- ``mpi/GenericIOVerify`` verify and try reading data +- ``mpi/GenericIOBenchmarkRead`` reading benchmark, works on data written + with ``GenericIOBenchmarkWrite`` +- ``mpi/GenericIOBenchmarkWrite`` writing benchmark + +-------------------------------------------------------------------------------- + +.. _doc-GenericIOPrint: + +GenericIOPrint +-------------- + +inspect GenericIO file and print data to stdout + +.. code-block:: + + Usage: GenericIOPrint [--no-rank-info|--no-data|--show-map] <filename> + +-------------------------------------------------------------------------------- + +.. _doc-GenericIOVerify: + +GenericIOVerify +--------------- + +verify and try reading data + +.. code-block:: + + Usage: GenericIOVerify [-v] <filename1> [<filename2> ...] + + Options: + -v verbose + +-------------------------------------------------------------------------------- + +.. _doc-GenericIORewrite: + +GenericIORewrite +---------------- + +rewrite data with a different number of ranks + +.. code-block:: + + Usage: GenericIORewrite <filenameOld> <filenameNew> + +-------------------------------------------------------------------------------- + +.. _doc-GenericIOBenchmarkRead: + +GenericIOBenchmarkRead +---------------------- + +reading benchmark, works on data written with ``GenericIOBenchmarkWrite`` + +.. code-block:: + + USAGE: GenericIOBenchmarkRead [-a] <filename> + + Options: + -a UseAOS (Array-Of-Structures for pos and vel) + +-------------------------------------------------------------------------------- + +.. _doc-GenericIOBenchmarkWrite: + +GenericIOBenchmarkWrite +----------------------- + +writing benchmark + +.. code-block:: + + USAGE: GenericIOBenchmarkWrite [-a] [-c] [-l] <filename> <NP> <seed> + + Options: + -a UseAOS (Array-Of-Structures for pos and vel) + -c compress data + -l UseLC (Lossy Compression) +