Some problems with paths for C++ in README

[hschellman]

I tried doing the examples.

first it would be really good not to assume people are using the home area.

export PHLEX-TEST=... someplace

cd $PHLEX-TEST
mkdir build-phlex-examples
cd build-phlex-examples

and then fix a typo in the make

spack env activate my-phlex-environment
spack load cmake
cmake ../phlex-examples
make -j

Builds fine for me but then I ran into the use of the home area

cd $PHLEX-TEST/phlex-example

phlex -c ./test-cpp-workflow.jsonnet
Using configuration file: test-cpp-workflow.jsonnet
[2026-01-01 13:29:46.107] [info] Number of worker threads: 24
[2026-01-01 13:29:46.107] [info]
[2026-01-01 13:29:46.107] [info] CPU time: 0.00106s Real time: 0.00352s CPU efficiency: 30.14%
[2026-01-01 13:29:46.107] [info] Max. RSS: 16.732 MB
Could not locate library with specification 'module' in any directories on PHLEX_PLUGIN_PATH.

I had to manually:

export PHLEX_PLUGIN_PATH=$PHLEX-TEST/build-phlex-examples/:$PHLEX_PLUGIN_PATH

and then it worked fine

the python example worked as well because it explicitly sets the PYTHON_PATH

I can make a pull request with these changes if people agree.

[hschellman]

I don't have access to the repository to do a pull request so here is the full source for an updated README.md

Phlex examples

This repository contains examples of the use of the Phlex framework.

Building this repository

To use the code in this repository, first install it:

export PHLEX-TEST=<location you want this in>
cd $PHLEX-TEST
git clone https://github.com/Framework-R-D/phlex-examples.git

Now create a build directory:

mkdir build-phlex-examples
cd build-phlex-examples

The repository can now be easily built by activating the environment you created when installing Phlex:

spack env activate my-phlex-environment
spack load cmake
cmake ../phlex-examples
make -j

Running the code

You should now be able to run a simple phlex job:

Job with C++ algorithms

export PHLEX_PLUGIN_PATH=../build-phlex-examples/:$PHLEX_PLUGIN_PATH
phlex -c $PHLEX-TEST/phlex-examples/test-cpp-workflow.jsonnet

Using configuration file: /../phlex-examples/test-cpp-workflow.jsonnet
[2025-12-22 13:17:51.496] [info] Number of worker threads: 24
Registering FORM output module...
Configuration:
  output_file: output.root
  technology: ROOT_TTREE
FormOutputModule initialized
⋮
[2025-12-22 13:17:51.760] [info]
Processed layers:

  job
   │
   └ spill: 10

[2025-12-22 13:17:51.760] [info] CPU time: 0.21204s  Real time: 0.26498s  CPU efficiency:  80.02%
[2025-12-22 13:17:51.760] [info] Max. RSS: 268.848 MB

Job with Python algorithms

To run a job that uses a Python algorithm, the PYTHONPATH environment variable must be adjusted to include the directory with the Python module:

export PYTHONPATH=$(realpath ~/phlex-examples):$PYTHONPATH
phlex -c $PHLEX-TEST/phlex-examples/test-py-workflow.jsonnet

Using configuration file: /home/knoepfel/phlex-examples/test-py-workflow.jsonnet
[2025-12-22 13:50:07.999] [info] Number of worker threads: 24
[2025-12-22 13:50:08.013] [info]
Processed layers:

  job

[2025-12-22 13:50:08.013] [info] CPU time: 0.01022s  Real time: 0.01483s  CPU efficiency:  68.91%
[2025-12-22 13:50:08.013] [info] Max. RSS: 29.628 MB

Note

For Phlex 0.1.0, Python data products:

• Cannot be written to output files
• Must belong to the "job" data layer