PlasBin-flow benchmarking framework

Install

Requires:

• slurm
• bash
• python 3.13

Python environments

With conda

• [For dev] Create the conda environment

  conda env create -n pbfbench-dev -f config/condaenv_313-dev.yml

• [For dev] Activate the conda environment

  conda activate pbfbench-dev

With virtualenv

python3.13 -m virtualenv .venv_pbfbench_313
source ./.venv_pbfbench_313/bin/activate  # active.fish for fish shell...
pip install .  # `pip install -e .` for editable mode i.e. for dev

Usage

pbfbench --help

Create automatic documentation

pbfbench doc auto  # creates autodoc in `docs` directory
pbfbench doc clean  # to clean the auto documentation