Command Line Interface

The rustpix CLI provides batch processing capabilities for TPX3 files.

Installation

cargo install rustpix-cli

Or build from source:

cargo build --release -p rustpix-cli

Commands

CommandDescription
processProcess TPX3 files to extract neutron events
infoShow information about a TPX3 file
benchmarkBenchmark clustering algorithms

Quick Examples

# Process a file
rustpix process input.tpx3 -o output.csv

# Show file info
rustpix info input.tpx3

# Benchmark algorithms
rustpix benchmark input.tpx3

# Get help
rustpix --help
rustpix process --help

Output Formats

The output format is determined by file extension:

ExtensionFormat
.csvComma-separated values with header
.bin, .datBinary format (compact)
OtherBinary format (default)

See Commands Reference for detailed usage.