Command-line interface (CLI)

The mpldc CLI gives you full access to the MPL-Data-Cast core functionalities. This section documents the output of the different commands (e.g. mpldc --help or mpldc cast --help).

mpldc

mpldc [OPTIONS] COMMAND [ARGS]...

Commands

cast: Convert and copy experimental data

list-recipes: List available recipes that can be used in the mpldc cast subcommand

mpldc cast

Cast data from a source directory to a target directory

This will convert all data under the tree in PATH_RAW and copy them to PATH_TARGET.

mpldc cast [OPTIONS] PATH_RAW PATH_TARGET

Options

-r, --recipe <recipe>: specifies recipe to use, defaults to ‘CatchAll’; see the mpldc list-recipes subcommand for more options

-o, --options <options>: comma-separated keyword arguments passed to the recipe’s convert_dataset method, e.g. wavelength=984e-9,pixel_size=1.2e-6

Arguments

PATH_RAW: Required argument

PATH_TARGET: Required argument

mpldc list-recipes

List available recipes that can be used in the mpldc cast subcommand

mpldc list-recipes [OPTIONS]