Charm++ Interface

Continuous Integration

Explanations on our automated tests and deployments can be found here.

Methods for creating custom coordinate maps are discussed here.

Build system and how to add dependencies, unit tests, and executables.
Executables and how to add them
Writing SpECTRE executables - A series of tutorials demonstrating how to write a parallel executable, and explaining some of the metaprogramming that turns user-provided code into a SpECTRE parallel executable
Option parsing to get options from input files
Importing data from files
Profiling With Charm++ Projections and PAPI for optimizing performance
Writing Python Bindings to use SpECTRE C++ classes and functions from within python.
Implementing SpECTRE vectors a quick how-to for making new generalizations of DataVectors
How to parse linker and compiler errors
Static analysis tools
Build Profiling and Optimization - Getting started with improving compilation time and memory use

Designed to give the reader an introduction to SpECTRE's most recurring concepts and patterns.

Terms with SpECTRE-specific meanings are defined here.

Writing good documentation is key for long term maintainability of the project.
Writing Unit Tests to catch bugs and to make sure future changes don't cause your code to regress.
GitHub Actions is used to test every pull request.
Code review guidelines. All code merged into develop must follow these requirements.

Assumes a thorough familiarity and fluency in SpECTRE's usage of TMP.

Explanations for TMP concepts and patterns known to the greater C++ community can be found here.