Overview
The experiment Python module provides Process and Figure definitions. This guide describes version 1.2.0. Begin with the product quick start.
Main capabilities
- Track sources, targets, Programs and parameters to rebuild affected work.
- Connect processing flows with automatically regenerated QC Figures.
- Run ready Processes locally or through configured Slurm execution profiles.
- Partition independent SOIG groups explicitly when group-wise parallel work is appropriate.
Choose an API
| API | Use |
|---|---|
Process | Transform sources into one or more targets. |
Figure | Generate PostScript or converted PDF/raster QC output. |
Quick example
Connect a Process to its QC Figure
from experiment import *
Process('result', 'input',
'sgfieldmath data="data*2"')
Figure('./result.png', 'result',
'sgplotps')Run scons to build data/result.sg and then generate result.png. Use man sgfieldmath and man sgplotps for the Program options.
Requirements and further reading
Run ordinary local workflows with scons. SCons is required; Ghostscript and ImageMagick provide supported figure conversions. Cluster execution requires a prepared Slurm profile, shared paths and matching packages and licenses on participating nodes.
Program threads, independent group chunks and concurrent Processes provide three levels of parallel work. Chunking is explicit and requires a flow that processes each group independently; selecting an HPC profile alone does not partition a dataset.
Use the API reference for arguments and file routing, and Execution and HPC setup for profiles and resource configuration. Version selectors in the menu apply to generated Program references; these guides describe the current API.