Home

Awesome

palanteer_rocker

Continuous Integration Status

Ci Codecov GitHub issues GitHub pull-requests merged GitHub release License Python Pixi Badge

Intro

This is a rocker extension for adding the palanteer profiler to a docker image. Check out the rocker GitHub page for more details on how rocker and its extensions work. In short, rocker allows you to add custom capabilities to existing docker images.

Installation

pip install palanteer-rocker

Usage

To install palanteer in an image use the --palanteer flag

#add palanteer to the ubuntu:22.04 image
rocker --palanteer ubuntu:22.04

# add palanteer to the nvidia/cuda image
rocker --palanteer nvidia/cuda

Note that the above example will install palanteer but not work out of the box because the container will not have the correct graphics settings.

To try a fully working example with graphics install rockerc

$ pip install rockerc

# move into the palanteer_rocker folder which contains a rockerc.yaml file with arguments for setting up graphics (and palanteer)
$ cd palanteer_rocker  

# launch rocker with graphics and palanteer flags 
$ rockerc

inside the container

$ palanteer