This chapter describes the internals of the PICMI translation (and subsequently the internal representation PyPIConGPU).
Warning
This section is aimed at developers. It describes how the PICMI user interface <../usage/picmi/index> is implemented.
For the PICMI in PIConGPU user documentation, see here <../usage/picmi/index>. For the PICMI standard (upstream) definition, see here.
If you read this documentation like a book carry on in the order of the table of contents. However, the recommended way is to also review the implementation side-by-side to this documentation:
To get started familiarize yourself with the translation process <translation> and skim how the testing approach<testing> works. Read the FAQ <faq> for some more fundamental questions. After looking at some examples of implementations yourself, continue with running <running>, the general notes on the implementation <misc>, and read the notes on how to write schemas<howto/schema>. If you have to work with species also read their section <species>. (Note: Species are by far the most complex issue in PyPIConGPU, make sure you understand the fundamentals before working on them.)