CMI Command-Line Interface (CLI)

The cmi command provides access to diffpy.cmi. It allows users to explore, install, and run packs, profiles, and example workflows.

Getting Help

The -h flag is available for all cmi commands and subcommands. It’s highly recommended to use it wherever necessary.

To display help for the main CLI, type

cmi -h
cmi --help

Display help for a specific subcommand with,

cmi <subcommand> -h

Open the full online manual in a web browser by typing,

cmi --manual

To print information about available and installed packs, profiles, and examples, type,

cmi info

To print information about packs, profiles, or examples, type

cmi info packs
cmi info profiles
cmi info examples

To install packs or profiles into your environment, type

cmi install <pack-name>
cmi install <profile-name>

Installation of multiple packs or profiles is also supported, e.g.,

cmi install <pack-name> <profile-name>

To view all examples available to copy, type

cmi info examples

To copy an example or list of examples to cwd, type

cmi copy <example-name>
cmi copy <example-name1> <example-name2>

To copy all examples from a pack or list of packs to cwd, type

cmi copy <pack-name>
cmi copy <pack-name1> <pack-name2>

To copy all examples to cwd, type

cmi copy all

To copy an example to a target directory, type

cmi copy <example-name> -t <target-directory>

To force overwrite a preexisting example directory, type

cmi copy <example-name> -f

To show basic information about your current conda environment, type

cmi env