Skip to content

Command Line Interface

This page provides documentation for the command line tools provided by this project.

wpd

Simulation of quantum dynamics.

Usage:

wpd [OPTIONS] COMMAND [ARGS]...

Options:

  --version  Show the version and exit.
  --help     Show this message and exit.

wpd animate

Animate the simulation results of data stored in OUTPUT_DIR.

Usage:

wpd animate [OPTIONS] OUTPUT_DIR

Options:

  --help  Show this message and exit.

wpd plot

Plot expectation values of simulation stored in OUTPUT_DIR.

Usage:

wpd plot [OPTIONS] OUTPUT_DIR

Options:

  --help  Show this message and exit.

wpd run

Run the simulation using an INPUT_FILE.

Usage:

wpd run [OPTIONS] INPUT_FILE

Options:

  --save-step INTEGER  Save simulation data every n-th step.  [default: 10]
  --save-dir PATH      Output directory.  [default: (same as INPUT_FILE)]
  --help               Show this message and exit.