This repository contains examples demonstrating the functionality of postpic (the open-source particle in cell post processor). Postpic is used to postprocess the particle and field data written by PIC simulations. Postpic is data format agnostic, so it can be easily extended to read a specific data format.

View the contents of this repository at:
http://nbviewer.jupyter.org/github/skuschel/postpic-examples/tree/master/

Alternatively download it to run in on your local machine. Please note, that some of the examples here depend on specialized readers for the data format and may not run unless their individual dependencies are satisfied, such as the SDF file format reader.

• postpic can be install without leaving the jupyter enviroment. This is particularly useful when working on a front-end node of a cluster, such as JURECA. The neccessary steps are explained in "00 installation and version check.ipynb".
• There are two basic examples, which are essentially identical, but work with different file formats, which is set in the first few notebook cells.
  • First, the epochSDF.ipynb, demonstrating basic usage when working with data from the EPOCH PIC code. Note, that the SDF reader (shipped with EPOCH) is neccessary to run it.
  • Secondly, an almost identical example using the openPMD format can be found here: openPMD.ipynb. This only requires an hdf5 reader.

Contributions of any kind are very welcome! Ideally there are jupyter notebooks containing working examples/use cases/demonstrations of functionality/minimal examples. However anything that is useful will be accepted. So when in doubt, use the issues page to start a discussion.

Use cases demonstrated in this repository can also be a good hint to develop a new feature. If the code proofs general enough, it may finally find its way into the postpic code base to simplify the use of postpic or add new functionality.