SpECTRE Documentation Coverage Report
Current view: top level - __w/spectre/spectre/docs/DevGuide - DevGuide.md Hit Total Coverage
Commit: 3f09028930c0450a2fb61ee918b22882f5d03d2b Lines: 0 1 0.0 %
Date: 2021-10-22 20:52:16
Legend: Lines: hit not hit

          Line data    Source code
       1           0 : \cond NEVER
       2             : Distributed under the MIT License.
       3             : See LICENSE.txt for details.
       4             : \endcond
       5             : # Developer Guides {#dev_guide}
       6             : 
       7             : ### Developing and Improving Executables
       8             : - \subpage spectre_build_system "Build system" and how to add dependencies, unit
       9             :   tests, and executables.
      10             : - \subpage dev_guide_creating_executables "Executables and how to add them"
      11             : - \subpage tutorials_parallel - A series of tutorials demonstrating how to write
      12             :   a parallel executable, and explaining some of the metaprogramming that turns
      13             :   user-provided code into a SpECTRE parallel executable
      14             : - \subpage dev_guide_option_parsing "Option parsing" to get options from input
      15             :   files
      16             : - \subpage dev_guide_importing "Importing" data from files
      17             : - \subpage profiling_with_projections "Profiling With Charm++ Projections" and
      18             :   PAPI for optimizing performance
      19             : - \subpage spectre_writing_python_bindings "Writing Python Bindings" to use
      20             :   SpECTRE C++ classes and functions from within python.
      21             : - \subpage implementing_vectors "Implementing SpECTRE vectors" a quick how-to
      22             :   for making new generalizations of DataVectors
      23             : - \subpage compiler_and_linker_errors "How to parse linker and compiler errors"
      24             : - \subpage static_analysis_tools "Static analysis tools"
      25             : - \subpage build_profiling_and_optimization - Getting started with improving
      26             :   compilation time and memory use
      27             : 
      28             : ### Having your Contributions Merged into SpECTRE
      29             : - \subpage writing_good_dox "Writing good documentation" is key for long term
      30             :   maintainability of the project.
      31             : - \subpage writing_unit_tests "Writing Unit Tests" to catch bugs and to make
      32             :   sure future changes don't cause your code to regress.
      33             : - \subpage travis_guide "Travis CI" is used to test every pull request.
      34             : - \subpage code_review_guide "Code review guidelines." All code merged into
      35             :   develop must follow these requirements.
      36             : 
      37             : ### General SpECTRE Terminology
      38             : Terms with SpECTRE-specific meanings are defined here.
      39             : - \subpage domain_concepts "Domain Concepts" used throughout the code are
      40             :   defined here for reference.
      41             : 
      42             : ### Charm++ Interface
      43             : - \subpage load_balancing_notes "Load Balancing Notes and Recommendations"
      44             : 
      45             : ### Template Metaprogramming (TMP)
      46             : Explanations for TMP concepts and patterns known to the greater C++ community
      47             : can be found here.
      48             : - \subpage sfinae "SFINAE"
      49             : 
      50             : ### Foundational Concepts in SpECTRE
      51             : Designed to give the reader an introduction to SpECTRE's most recurring concepts
      52             : and patterns.
      53             : - \subpage databox_foundations "Towards SpECTRE's DataBox"
      54             : - \subpage protocols "Protocols: metaprogramming interfaces"
      55             : 
      56             : ### Technical Documentation for Fluent Developers
      57             : Assumes a thorough familiarity and fluency in SpECTRE's usage of TMP.
      58             : - \subpage DataBoxGroup "DataBox"
      59             : - \subpage observers_infrastructure_dev_guide "Observers infrastructure"
      60             : - \subpage dev_guide_parallelization_foundations - Parallelization
      61             :   infrastructure components and usage
      62             : 
      63             : ### CoordinateMap Guide
      64             : Methods for creating custom coordinate maps are discussed here.
      65             : - \subpage redistributing_gridpoints "Methods for redistributing gridpoints"
      66             : 
      67             : ### Continuous Integration
      68             : Explanations on our automated tests and deployments can be found here.
      69             : 
      70             : - \subpage dev_guide_automatic_versioning

Generated by: LCOV version 1.14