Loading docs/user_guide/source/operators/ZFPCompressor.rst→docs/user_guide/source/operators/CompressorZFP.rst +11 −11 Original line number Diff line number Diff line ************* ZFPCompressor CompressorZFP ************* The ``ZFPCompressor`` Operator is compressor that uses a lossy but optionally The ``CompressorZFP`` Operator is compressor that uses a lossy but optionally error-bounded compression to achieve high compression ratios. ZFP provides compressed-array classes that support high throughput read and Loading @@ -10,27 +10,27 @@ write random access to individual array elements. ZFP also supports serial and parallel (OpenMP and CUDA) compression of whole arrays, e.g., for applications that read and write large data sets to and from disk. ADIOS2 provides a ``ZFPCompressor`` operator that lets you compress an ADIOS2 provides a ``CompressorZFP`` operator that lets you compress an decompress variables. Below there is an example of how to invoke ``ZFPCompressor`` operator: ``CompressorZFP`` operator: .. code-block:: c++ adios2::IO io = adios.DeclareIO("Output"); auto ZFPOp = adios.DefineOperator("ZFPCompressor", adios2::ops::LossyZFP); auto ZFPOp = adios.DefineOperator("CompressorZFP", adios2::ops::LossyZFP); auto var_r32 = io.DefineVariable<float>("r32", shape, start, count); var_r32.AddOperation(ZFPOp, {{adios2::ops::zfp::key::rate, rate}}); ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ZFPCompressor Specific parameters CompressorZFP Specific parameters ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ The ``ZFPCompressor`` operator accepts the following operator specific The ``CompressorZFP`` operator accepts the following operator specific parameters: +-------------------+---------------------------------------------+ | ``ZFPCompressor`` available parameters | | ``CompressorZFP`` available parameters | +===================+=============================================+ | ``accuracy`` | Fixed absolute error tolerance | +-------------------+---------------------------------------------+ Loading @@ -42,11 +42,11 @@ parameters: +-------------------+---------------------------------------------+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ZFPCompressor Execution Policy CompressorZFP Execution Policy ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ``ZFPCompressor`` can run in multiple backend devices: GPUs (CUDA), OpenMP, and in the host CPU. By default ``ZFPCompressor`` will choose its backend following ``CompressorZFP`` can run in multiple backend devices: GPUs (CUDA), OpenMP, and in the host CPU. By default ``CompressorZFP`` will choose its backend following the above order upon the availability of the device adapter. Exceptionally, if its corresponding ADIOS2 variable contains a CUDA memory Loading docs/user_guide/source/operators/operators.rst +1 −2 Original line number Diff line number Diff line Loading @@ -7,7 +7,6 @@ either from a ``adios2::Variable`` or a set of Variables in an ``adios2::IO`` object. Current supported operations are: 1. Data compression/decompression, lossy and lossless. 2. Callback functions (C++11 bindings only) supported by specific engines This section provides a description of the :ref:`Available Operators` in ADIOS2 and their specific parameters to allow extra-control from the user. Parameters Loading @@ -24,6 +23,6 @@ Parameters are passed at: 2. :ref:`Runtime Configuration Files` in the :ref:`ADIOS` component. .. include:: ZFPCompressor.rst .. include:: CompressorZFP.rst .. include:: plugin.rst .. include:: encryption.rst Loading
docs/user_guide/source/operators/ZFPCompressor.rst→docs/user_guide/source/operators/CompressorZFP.rst +11 −11 Original line number Diff line number Diff line ************* ZFPCompressor CompressorZFP ************* The ``ZFPCompressor`` Operator is compressor that uses a lossy but optionally The ``CompressorZFP`` Operator is compressor that uses a lossy but optionally error-bounded compression to achieve high compression ratios. ZFP provides compressed-array classes that support high throughput read and Loading @@ -10,27 +10,27 @@ write random access to individual array elements. ZFP also supports serial and parallel (OpenMP and CUDA) compression of whole arrays, e.g., for applications that read and write large data sets to and from disk. ADIOS2 provides a ``ZFPCompressor`` operator that lets you compress an ADIOS2 provides a ``CompressorZFP`` operator that lets you compress an decompress variables. Below there is an example of how to invoke ``ZFPCompressor`` operator: ``CompressorZFP`` operator: .. code-block:: c++ adios2::IO io = adios.DeclareIO("Output"); auto ZFPOp = adios.DefineOperator("ZFPCompressor", adios2::ops::LossyZFP); auto ZFPOp = adios.DefineOperator("CompressorZFP", adios2::ops::LossyZFP); auto var_r32 = io.DefineVariable<float>("r32", shape, start, count); var_r32.AddOperation(ZFPOp, {{adios2::ops::zfp::key::rate, rate}}); ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ZFPCompressor Specific parameters CompressorZFP Specific parameters ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ The ``ZFPCompressor`` operator accepts the following operator specific The ``CompressorZFP`` operator accepts the following operator specific parameters: +-------------------+---------------------------------------------+ | ``ZFPCompressor`` available parameters | | ``CompressorZFP`` available parameters | +===================+=============================================+ | ``accuracy`` | Fixed absolute error tolerance | +-------------------+---------------------------------------------+ Loading @@ -42,11 +42,11 @@ parameters: +-------------------+---------------------------------------------+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ZFPCompressor Execution Policy CompressorZFP Execution Policy ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ``ZFPCompressor`` can run in multiple backend devices: GPUs (CUDA), OpenMP, and in the host CPU. By default ``ZFPCompressor`` will choose its backend following ``CompressorZFP`` can run in multiple backend devices: GPUs (CUDA), OpenMP, and in the host CPU. By default ``CompressorZFP`` will choose its backend following the above order upon the availability of the device adapter. Exceptionally, if its corresponding ADIOS2 variable contains a CUDA memory Loading
docs/user_guide/source/operators/operators.rst +1 −2 Original line number Diff line number Diff line Loading @@ -7,7 +7,6 @@ either from a ``adios2::Variable`` or a set of Variables in an ``adios2::IO`` object. Current supported operations are: 1. Data compression/decompression, lossy and lossless. 2. Callback functions (C++11 bindings only) supported by specific engines This section provides a description of the :ref:`Available Operators` in ADIOS2 and their specific parameters to allow extra-control from the user. Parameters Loading @@ -24,6 +23,6 @@ Parameters are passed at: 2. :ref:`Runtime Configuration Files` in the :ref:`ADIOS` component. .. include:: ZFPCompressor.rst .. include:: CompressorZFP.rst .. include:: plugin.rst .. include:: encryption.rst
