Skip to content

Commit 07c7f2e

Browse files
committed
Document verify_homogeneous_extents option
1 parent 6a704ce commit 07c7f2e

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

docs/source/details/backendconfig.rst

+5
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,11 @@ Using the Streaming API (i.e. ``SeriesInterface::readIteration()``) will do this
9494
Parsing eagerly might be very expensive for a Series with many iterations, but will avoid bugs by forgotten calls to ``Iteration::open()``.
9595
In complex environments, calling ``Iteration::open()`` on an already open environment does no harm (and does not incur additional runtime cost for additional ``open()`` calls).
9696

97+
As of openPMD-api 0.17.0, the parser verifies that all records within a mesh or within a particle species have consistent shapes / extents.
98+
This is used for filling in the shape for constant components that do not define it.
99+
In order to skip this check in the error case, the key ``{"verify_homogeneous_extents": false}`` may be set (alternatively ``export OPENPMD_VERIFY_HOMOGENEOUS_EXTENTS=0`` will do the same).
100+
This will help read datasets with inconsistent metadata definitions.
101+
97102
The key ``resizable`` can be passed to ``Dataset`` options.
98103
It if set to ``{"resizable": true}``, this declares that it shall be allowed to increased the ``Extent`` of a ``Dataset`` via ``resetDataset()`` at a later time, i.e., after it has been first declared (and potentially written).
99104
For HDF5, resizable Datasets come with a performance penalty.

0 commit comments

Comments
 (0)