Developer Guide

ALCF Polaris

These are steps that are needed to compile dftracer on ALCF Polaris

First, make sure you have set up the environment variable and source it as shown here. Then, you can modify the dftracer codebase and compile the codebase by running commands below:

module use /soft/modulefiles
module load conda
module unload darshan
conda activate base
source <your venv>

export CC=cc
export CXX=CC
export CMAKE_BUILD_TYPE=PROFILE
export DFTRACER_ENABLE_TESTS=On
export DFTRACER_LOGGER_USER=1
export DFTRACER_DISABLE_HWLOC=On
export DFTRACER_TEST_LD_LIBRARY_PATH=/opt/cray/libfabric/1.15.2.0/lib64
pip install -v ".[dfanalyzer]"

Note

We need to disable darshan here because it will give you a lot of segfault on Polaris machine due to POSIX API interceptor done by Darshan

Then, to run the the test, you need to run commands below:

module use /soft/modulefiles
module load conda
module unload darshan
conda activate base
source <your venv>

pip install -r test/py/requirements.txt
pushd build/temp*/*dftracer*/
ctest -E dlio -VV --debug --stop-on-failure
popd

Updating Docs

For updating the docs we need to install additional dependency Sphinx

module use /soft/modulefiles
module load conda
module unload darshan
conda activate base
source <your venv>

pip install "Sphinx<7"

cd <dftracer>/docs
make html

Then open _build/html/index.html