Developing POLARIS

The POLARIS modelling framework is a complicated system comprising a high performance c++ core with a powerful Python based automation layer. Theese components are stored in separate Git repositories and keeping the development of these components in step with each other is a non-trivial endeavour that requires our team to utilise a number of software development processes to ensure the quality of our software. Before embarking on the development of new features, contributors should make sure they are familiar with the software development practices detailed here.

Building POLARIS Source

The first steps to adding new functionality for POLARIS is to setup a functioning compilation environment.

• Getting setup
  • Quick Start
• Dependencies
  • Getting Pre-built Dependencies
  • Building Dependencies from source
  • Adding new dependencies
• Building Code

Working with POLARIS

When you are able to compile POLARIS on your computer, the following sections will help you with understanding the overall structure of the system.

• System Architecture
• Libraries
• Software Development Practices
• Release cycle
• Git
• Working with GitLab
• Logging
• Common Preprocessor Macros
• Interpreting Stack Traces
• Debugging
• Tutorials