Welcome the documentation of neSmiK

neSmiK is created out of the need to have a common infrastructure to annotate code regions and integrate them with different performance tools.

The idea is to have yet another layer in the huge cake that is the software stack. This middle layer is used to orchestrate and combine the different performance tools, without the user needing to know anything about the specifics on how to interface with these tools.

In this documentation we try to follow the diataxis concept. We are also happy about feedback or contributions to this documentation. Feel free to consult our GitLab page for more information on how to contribute.

I wanna use neSmiK:

• How to install neSmiK
  • Requirements
  • Optional dependencies
  • Configuration options
  • Installation steps
• How to guides
  • First steps
  • Annontating applications
• Annotation API
  • C++ API
  • C API
  • Fortran API
• Using Backends
  • Independent backends
  • Extrae Backends
  • DLB Backends
  • NVTX Backends
• Environment Flags
  • NESMIK_BACKEND
  • NESMIK_MAX_NESTING_LEVEL
  • NESMIK_BLACKLIST
• A bit of theory
  • Nesting of regions
  • Parallelism awareness