Developer Guide

The developer guide is intended to be for people who come in more close contact with HOPR, i.e., code developers and performance analysts as well as people who are tasked with working or extending the documentation of HOPR.

Table of Contents

• 1. Github Workflow
• 2. Style Guide
• 3. Building the Documentation
• 4. Compiler Options
• 5. Building the AppImage Executable
• 6. Troubleshooting
• 7. Markdown Examples

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.

• The first Chapter Github Workflow shall give an overview over the development workflow within the GitHub environment, and the necessary steps to create a release and deploy updates to GitHub.

• The second Chapter Style Guide describes the rules and guidelines regarding code development such as how the header of functions and subroutines look like.

• Chapter Building the Documentation describes how to build the html and pdf files locally before committing changes to the repository.

• Chapter Compiler Options gives an overview of compiler options that are used in HOPR and their purpose.

• Chapter Building the AppImage Executable described how an AppImage executable of HOPR is created.

• Chapter Markdown Examples gives a short overview of how to include code, equations, figures, tables etc. in the user and developer guides in Markdown.