Developer's Guide

Developing and Improving Executables

• Build system and how to add dependencies, unit tests, and executables.
• Executables and how to add them
• Option parsing to get options from input 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

Having your Contributions Merged into SpECTRE

• 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.
• Travis CI is used to test every pull request.
• Code review guidelines. All code merged into develop must follow these requirements.

General SpECTRE Terminology

Terms with SpECTRE-specific meanings are defined here.

• Domain Concepts used throughout the code are defined here for reference.

Template Metaprogramming (TMP)

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

• SFINAE

Foundational Concepts in SpECTRE

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

• Towards SpECTRE's DataBox

Technical Documentation for Fluent Developers

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

• DataBox
• Parallelization infrastructure components and usage

CoordinateMap Guide

Methods for creating custom coordinate maps are discussed here.

• Methods for redistributing gridpoints