Getting Started

Table of Contents

• Project Integration
  • timemory as a Submodule
  • Using CMake
    • Available CMake Targets
    • find_package Approach with COMPONENTS
  • Using Makefiles
  • Compilation with the Template Interface
• Getting Started
  • Dynamic Instrumentation
  • Initialization and Finalization
  • Basic API
    • C++ Toolkit Initialization and Finalization
    • C / C++ Library Initialization and Finalization
    • Python Initialization and Finalization
    • C / C++ Library Interface
    • Fortran
    • C++ Toolkit Interface
    • Python Context Manager
    • Python Decorator
    • Python Component Class
    • C Enumeration Interface
    • Python
  • Environment Controls
• Roofline
  • Generating Roofline Data
  • Roofline Python Module: timemory.roofline
    • Generating Roofline Plot with timemory.roofline
    • Executing an Application with timemory.roofline
  • Customizing the calculation of the “roof” for the Roofline
  • Configuring number of threads in the Roofline
  • Full Customization of the Roofline Model