Command Reference

Jump to bottom

Codex Checkpoint edited this page Jun 18, 2026 · 2 revisions

Commands

PAIPAI installs four user-facing commands:

Command	Purpose
[[paipai	Command-paipai]]
[[findinter	Command-findinter]]
[[packmc	Command-packmc]]
[[warrencowley	Command-warrencowley]]

Internal/runtime programs are installed too, but most users do not call them directly:

Internal program	Purpose
`mc_paipai`	C++ Monte Carlo master called by `paipai`.
`fast_worker.py`	Coarse relaxation worker launched by `paipai` in search mode.
`slow_worker.py`	Refinement worker launched by `paipai`.

Recommended Entry Points

To run PAIPAI, use paipai.
To generate an initial structure, use findinter.
To collect accepted CONTCAR files and build a summary TSV, use packmc.
To compute local chemical-order statistics, use warrencowley.