Skip to content

PIConGPU User Documentation

Jump to bottom Edit New page
Axel Huebl edited this page Oct 24, 2017 · 44 revisions

You are here: Home > PIConGPU User Documentation

Welcome to the user documentation for PIConGPU. Please be aware that we are still in Open Alpha stage. Hence, interfaces can not be expected be be stable nor is their documentation complete. If you want to try PIConGPU anyway, the following sections should provide a good introduction. All others are advised to wait until the Open Beta stage.

The material below can be seen as a tutorial on using PIConGPU and should be followed in the proposed order. It assumes you have already installed PIConGPU and its prerequisites (see https://github.com/ComputationalRadiationPhysics/picongpu#install)

  1. Starting a simulation
    1. Parameter files (*.param)
  2. Examples
  3. Configure an example
  4. Particle Attributes
  5. Plugins
  6. Post-Processing: Python, openPMD and ParaView
  7. Restarting a simulation

Further material:

All wiki entries describe the dev branch. Features may be different in the current master branch.

Before you start please read our README!

PIConGPU is a scientific project. If you present and/or publish scientific results that used PIConGPU, you should set a reference to show your support. Our according up-to-date publication at the time of your publication should be inquired from:

The documentation in this wiki is still not complete and we need your help keeping it up to date. Feel free to help improving this wiki!

Add a custom sidebar
Clone this wiki locally