Command-Line Usage
The executable accepts name=value tokens. Do not put spaces around =
on the command line.
./cballs searchMethod=octree-ggg-omp nbody=4096 rootDir=Output
Syntax
Run entirely from command-line parameters:
./cballs name=value name=value ...
or pass a parameter file as the first argument:
./cballs path/to/parameters_file
Parameter files use name = value and may contain explanatory comments.
Use full names in files even when the CLI offers a short alias.
Discovery Commands
./cballs --help
./cballs --clue
The available defaults depend on Makefile_settings and enabled add-ons, so
the help output from the compiled executable takes precedence over copied
examples.
Common Parameters
Parameter |
Typical default |
Purpose |
|---|---|---|
|
|
Select the tree, octree, k-d-tree, or neighbor-box implementation. |
|
empty |
Input catalog or comma-separated catalogs. |
|
|
Input format or comma-separated format list. |
|
|
Catalog labels used for auto- or cross-correlations. |
|
|
Directory for histograms, parameters, and logs. |
|
|
Number of radial bins. |
|
build dependent |
Minimum and maximum radial separations. |
|
|
Highest 3PCF multipole index; |
|
|
Requested OpenMP thread count. |
|
|
Console and log verbosity. |
|
empty |
Comma-separated behavior flags such as |
The complete historical parameter descriptions remain in Parameters and
tests/In/parameters_explained.
Reproducible Runs
For production work, save the command or parameter file together with the
generated *-usedvalues record, the commit hash, compiler version, active
Makefile settings, and input-catalog metadata.