Developer Guide
The developer guide is intended to be for people who come in more close contact with PICLas, i.e., code developers and performance analysts as well as people who are tasked with working or extending the documentation of PICLas.
This guide is organized to guide the first implementation steps as well as provide a complete overview of the simulation code’s features from a developer’s point of view.
Chapter Development Workflow describes the development process with issues, milestones and merge requests on GitLab.
Chapter Style Guide describes the rules for writing code, such as the file header and the header of functions and subroutines.
Chapter Linting describes the Fortran linter Fortitude and the Python linter Ruff, and how to fix their violations.
Chapter Code Extension describes how to extend standardized code blocks, e.g. add a new variable to the output, and lists useful functions and subroutines.
Chapter Writing Documentation describes how to build the documentation locally and how to prepare figures.
Chapter Release & Deployment describes how to create a release, deploy it to GitHub and build the AppImage executable.
Chapter MPI Implementation gives the rules for MPI and shared memory windows and describes how PICLas is parallelized.
Chapter Regression Testing describes the continuous integration through regression testing.
Chapter Unit tests shows which unit tests check individual key components of the source code.
Chapter Troubleshooting collects known problems from past debugging sessions, compiler options and the warnings check.
Chapter Performance Analysis describes tools for measuring the computational performance.