Skip to content

Commit

Permalink
First read/write
Browse files Browse the repository at this point in the history
  • Loading branch information
franzpoeschel committed Feb 28, 2024
1 parent d19a50b commit aa673d2
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 3 deletions.
14 changes: 12 additions & 2 deletions docs/source/usage/firstread.rst
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ C++17
.. code-block:: cpp
auto series = io::Series(
"data%T.h5",
"data_%T.h5",
io::Access::READ_ONLY);
Expand All @@ -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
---------

Expand Down
2 changes: 1 addition & 1 deletion docs/source/usage/firstwrite.rst
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ Python
Iteration
---------

Grouping by an arbitrary, positive integer number ``<N>`` in a series:
Grouping by an arbitrary, nonnegative integer number ``<N>`` in a series:

C++17
^^^^^
Expand Down

0 comments on commit aa673d2

Please sign in to comment.