All Examples
The full list of example scripts shown below is also contained in our examples/
folder.
Example data sets can be downloaded from: github.com/openPMD/openPMD-example-datasets.
The following command will automatically install those into samples/
on Linux and OSX: curl -sSL https://git.io/JewVw | bash
C++
1_structure.cpp: creating a first series
2_read_serial.cpp: reading a mesh & a particle species
2a_read_thetaMode_serial.cpp: read an azimuthally decomposed mesh (and reconstruct it)
3_write_serial.cpp: writing a mesh
3a_write_thetaMode_serial.cpp: write an azimuthally decomposed mesh
3b_write_resizable_particles.cpp: write particles in a resizeable dataset
4_read_parallel.cpp: MPI-parallel mesh read
5_write_parallel.cpp: MPI-parallel mesh write
6_dump_filebased_series.cpp: detailed reading with a file-based series
7_extended_write_serial.cpp: particle writing with patches and constant records
10_streaming_write.cpp / 10_streaming_read.cpp: ADIOS2 data streaming
12_span_write.cpp: using the span-based API to save memory when writing
Benchmarks
8_benchmark_parallel.cpp: a MPI-parallel IO-benchmark
8a_benchmark_write_parallel.cpp: creates 1D/2D/3D arrays, with each rank having a few blocks to write to
8b_benchmark_read_parallel.cpp: read slices of meshes and particles
Python
2_read_serial.py: reading a mesh & a particle species
2a_read_thetaMode_serial.py: reading an azimuthally decomposed mesh (and reconstruct it)
3_write_serial.py: writing a mesh
3a_write_thetaMode_serial.py: write an azimuthally decomposed mesh
3b_write_resizable_particles.py: write particles in a resizeable dataset
4_read_parallel.py: MPI-parallel mesh read
5_write_parallel.py: MPI-parallel mesh write
7_extended_write_serial.py: particle writing with patches and constant records
9_particle_write_serial.py: writing particles
10_streaming_write.py / 10_streaming_read.py: ADIOS2 data streaming
11_particle_dataframe.py: reading data into Pandas dataframes or Dask for distributed analysis
12_span_write.py: using the span-based API to save memory when writing
Unit Tests
Our unit tests in the test/
folder might also be informative for advanced developers.