openPMD plugin for VisIt
Table of Contents
This repository contains the sources of an openPMD plugin for the visualization
This plugin now handles openPMD files in HDF5.
It works both in sequential and parallel.
The plugin can read Cartesian and axisymmetrical geometry (referred to
thetaMode in the standard).
Repository and code structure
This repository contains:
- The C++ source files
- An xml file
OpenPMD.xmlessential for building the plugin with VisIt tools
- The directory
docsthat contains the documentation
- The resources to generate a doxygen doc (in the directory
/Doxygen) that describes the different classes
Sources are composed of files generated by VisIt:
avtOpenPMDFileFormat.C: class for reading and converting file format in vtk
And external C++ classes developed for reading openPMD files:
PMDFile.C: Open, scan and print openPMD file structures
PMDiteration.C: class for the iteration groups
PMDField.C: class for the field groups
PMDParticle.C: class for the particle groups
docs directory contains:
How works this plugin
VisIt plugins basically read outputs with some specific code or data formats to convert them internally into vtk readable data.
How to generate the Doxygen documentation
First, download and install Doxygen.
You can create the documentation by command line (see this page for more information)
You can also use the GUI frontend. Open
Doxygen/Doxyfile, go to
Run, click on
Run Doxygen and finally
Show HTML output.
For more information about how to generate install a plugin, please, consider the following links:
Visit contains a series of tools that makes it easy to create and generate
plugins. Without going to the details, we will use one of them (
to install this plugin. These tools are located in the
<Visit application directory>/Contents/Resources/bin/.
You also need to install a recent version of cmake.
You can find instructions to install and use the plugin depending on your