Command line interface¶
CELL provides the cell command for structure generation, model fitting,
predictions, sampling, plotting, and inspection of saved artifacts. The reference
below covers every command registered by the documented CELL version, including
aliases. Each page contains the command’s actual flags, argument descriptions,
defaults, and implementation docstring.
Getting started¶
Show the available commands, inspect a command’s options, or inspect a saved model:
cell --help
cell build_model_from_sset --help
cell print_info_model model.pickle
The command-line usage blocks on the reference pages are generated from the
same argument parser used by cell. Use the short or long option names shown
there. For workflows and structured values such as dictionaries and lists,
use a TOML input file:
cell --input_file workflow.toml
With no arguments, cell also reads cellinput.toml if it exists in the
current directory.
Ordered TOML workflows¶
Give each step a unique table name and select its command with command.
Put do before any table header to select and order the steps. For example,
given an existing dss.pickle, inspect it, export its configurations, and
inspect the resulting structure set:
do = ["inspect", "export", "inspect_export"]
[inspect]
command = "print_info_derivative_structures"
dss_filepath = "dss.pickle"
[export]
command = "convert_dss_to_sset"
dss_filepath = "dss.pickle"
sset_filepath = "structures.xyz"
[inspect_export]
command = "print_info_sset"
sset_filepath = "structures.xyz"
A command can appear in several named steps with different arguments. Without
do, steps run in their input order. Add ignore = true inside a step to
skip it. CELL validates the selected command names and argument signatures
before executing the workflow.
Legacy [command_name] tables and [[command_name]] arrays remain supported.
Array entries execute as a group; use named steps when repeated commands must
be interleaved with other operations.
Custom commands¶
To load additional commands, set custom_dir and custom_modules at the
top level of the input file, before the step tables. Each Python module must
export a commands list containing the names of its command functions. For
a module my_commands.py that provides my_command(value), an input is:
custom_dir = "/path/to/commands"
custom_modules = ["my_commands.py"]
do = ["custom_step"]
[custom_step]
command = "my_command"
value = 3
The same custom_dir and custom_modules settings can be placed in a
separate custom_cell_commands.toml file in the working directory.
Command reference¶
Structures and symmetry¶
Correlation matrices and models¶
Sampling and free energies¶
Properties and masks¶
Conversion and export¶
Inspecting saved artifacts¶
Plotting¶
NOMAD integration¶
Testing¶
Aliases¶
These names remain available for existing workflows. Their pages link to the corresponding command documentation.