Getting started

Install with Homebrew

On macOS or Linux, add the ORNL tap and install Xylem:

brew tap research-enablement/xylem https://code.ornl.gov/research-enablement/homebrew-xylem.git
brew install xylem
xylem --version

Download the current Linux binary from the Xylem releases, make it executable, and place it on PATH:

chmod +x ./xylem
sudo mv ./xylem /usr/local/bin/xylem
xylem --version

Xylem requires the Rust toolchain declared by the workspace:

git clone https://code.ornl.gov/research-enablement/xylem.git
cd xylem
cargo install --locked --path xylem-cli
xylem --version

Run a configuration with informational logging:

xylem -vv run --config path/to/config.json

Add one or more inputs at the command line when the configuration does not declare them:

xylem --threads 4 -vv run --config path/to/config.json --input first,second

Use xylem --help and xylem run --help for the exact options supported by the installed version.