From aa673d2714b11485d699a0b869ba57472e9becee Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Franz=20P=C3=B6schel?= Date: Wed, 28 Feb 2024 15:43:30 +0100 Subject: [PATCH] First read/write --- docs/source/usage/firstread.rst | 14 ++++++++++++-- docs/source/usage/firstwrite.rst | 2 +- 2 files changed, 13 insertions(+), 3 deletions(-) diff --git a/docs/source/usage/firstread.rst b/docs/source/usage/firstread.rst index 673f69acc4..66136ab4af 100644 --- a/docs/source/usage/firstread.rst +++ b/docs/source/usage/firstread.rst @@ -86,7 +86,7 @@ C++17 .. code-block:: cpp auto series = io::Series( - "data%T.h5", + "data_%T.h5", io::Access::READ_ONLY); @@ -96,9 +96,19 @@ Python .. code-block:: python3 series = io.Series( - "data%T.h5", + "data_%T.h5", io.Access.read_only) +.. tip:: + + Replace the file ending ``.h5`` with a wildcard ``.%E`` to let openPMD autodetect the ending from the file system. + +.. tip:: + + More detailed options can be passed via JSON or TOML as a further constructor parameter. + Try ``{"defer_iteration_parsing": true}`` to speed up the first access. + (Remember to explicitly ``it.open()`` iterations in that case.) + Iteration --------- diff --git a/docs/source/usage/firstwrite.rst b/docs/source/usage/firstwrite.rst index 3361214926..927d9f650d 100644 --- a/docs/source/usage/firstwrite.rst +++ b/docs/source/usage/firstwrite.rst @@ -100,7 +100,7 @@ Python Iteration --------- -Grouping by an arbitrary, positive integer number ```` in a series: +Grouping by an arbitrary, nonnegative integer number ```` in a series: C++17 ^^^^^