Add support for reading OpenPMD files

Co-authored-by: Krishiv Bhatia <[email protected]> Co-authored-by: Gabriele Bozzola <[email protected]>"
Sbozzolo · Jun 19, 2024 · 869f061 · 869f061
1 parent a9496d8
commit 869f061
Show file tree

Hide file tree

Showing 15 changed files with 1,287 additions and 672 deletions.
diff --git a/NEWS.md b/NEWS.md
@@ -1,11 +1,15 @@
 # Changelog
 
-## Version 1.5.0
+## Version 1.5.0 (19 June 2023)
 
 #### General
 - Python 3.12 is now supported, Python 3.8.1 is required for development.
 - `total_filesize` now errors out when directories are passed.
 
+#### Features
+- Added experimental support for reading OpenPMD files (with most of the
+  heavy-lifting done by @krishivbhatia). Please, report any issue you might find.
+
 ## Version 1.4.0 (2 May 2023)
 
 #### General

diff --git a/docs/features.rst b/docs/features.rst
@@ -119,7 +119,7 @@ Units
 Grid Data
 ---------
 
-- Read 1D, 2D, and 3D ASCII and HDF5 files as ``HierarchicalGridData``, which supports:
+- Read 1D, 2D, and 3D ASCII, HDF5 and OpenPMD (experimental) files as ``HierarchicalGridData``, which supports:
 
   - working with multiple components and refinement levels;
   - handling ghost-zones;

diff --git a/docs/index.rst b/docs/index.rst
@@ -51,7 +51,7 @@ For a full list of available features, see the :doc:`features page <features>`.
   (:py:mod:`~.tensor`).
 - Work with 1D, 2D, and 3D grid functions (:py:mod:`~.grid_data`,
   :py:mod:`~.cactus_grid_functions`) as output by ``CarpetIOHDF5`` or
-  ``CarpetIOASCII``.
+  ``CarpetIOASCII``, or in OpenPMD format.
 - Work with horizon data from (:py:mod:`~.cactus_horizons`) as output by
   ``QuasiLocalMeasures`` and ``AHFinderDirect``.
 - Perform common operations with horizons (:py:mod:`~.hor_utils`).