Guide

Tutorials

• 1. Getting started

  Install for this tutorial: pip install scope-profiler (base install only).

• 2. Post-processing profiling data

  Install for this tutorial: pip install "scope-profiler[pproc]"; pandas is used for the DataFrame examples.

• 

  3. Visualizing results

  Install for this tutorial: pip install "scope-profiler[pproc]".

• 4. Profiling modes and configuration

  Install for this tutorial: pip install scope-profiler covers the executable examples. The optional sections require scope-profiler[line-profiler], scope-profiler[mpi], or scope-profiler[likwid] as…

• 5. Custom analysis with the Python API

  Install for this tutorial: pip install "scope-profiler[pproc]"; pandas is used for event analysis.

• 

  6. Building your own plots

  Install for this tutorial: pip install "scope-profiler[pproc]".

• 

  7. Notebook magics

  Install for this tutorial: pip install "scope-profiler[notebook,pproc,line-profiler]".

• 8. Reports and comparison

  Install for this tutorial: pip install "scope-profiler[pproc]" (interactive charts in the HTML report). The site command also needs scope-profiler[site] (PyYAML), which pproc already includes.

Guides

• Threads, tasks and coroutines

  Install for this page: pip install scope-profiler (base install only).

• Configuration

  Install for this page: pip install scope-profiler. The compression section additionally needs pip install "scope-profiler[compression]".

• Deploying a profiling dashboard

  Install for this page: pip install scope-profiler to write the data; npm install @scope-profiler/plotly plus a Plotly bundle to render it.

• 

  HDF5 output & post-processing from Python

  Install for this page: pip install "scope-profiler[pproc]" enables all examples. Reading HDF5 and inspecting regions need only the base install; pandas DataFrames and plotting need pproc.

• Line-by-line profiling

  Install for this page: pip install "scope-profiler[line-profiler]".

• Profiling modes

  Install for this page: pip install scope-profiler (base install only).

• MPI support

  Install for this page: pip install "scope-profiler[mpi]", plus an MPI implementation such as Open MPI or MPICH. Parallel HDF5 output additionally requires an MPI-enabled build of h5py; serial-HDF5…

• 

  Jupyter/IPython magics

  Install for this page: pip install "scope-profiler[notebook,pproc,line-profiler]" enables every example. notebook alone covers the basic magics, pproc adds plots and DataFrames, and line-profiler…

• 

  Profiling overhead

  Install for this page: pip install "scope-profiler[pproc]"; the benchmark uses maxplotlib to save its result as a figure.

• 

  Plotting with the CLI

  Install for this page: pip install "scope-profiler[pproc]", including the optional interactive PyVis call-graph backend.

• Plotly figures for the web

  Install for this page: export data with pip install scope-profiler; render it in a web project with npm install @scope-profiler/plotly plotly.js-dist-min.

• Profiling regions

  Install for this page: pip install scope-profiler (base install only).