ChimeraX docs icon

Command: devel

The devel command includes several functions for building and installing ChimeraX bundles:

devel alias [ name [ path ]]
devel unalias  name
Assign a convenient name to a path on the system, for use in other devel commands. If no arguments are given, list all of the currently defined path aliases. If name but not path is given, report the path aliased to that name. If a new path is entered for a name already in use, the new alias will replace the old one. The command devel unalias deletes the alias associated with name.
devel build  path  [ debug  true | false ] [ exit  true | false ]
Build the bundle at path (or a name previously defined with devel alias). The debug option indicates whether to build any compiled extensions with debugging information (default false). The exit option indicates whether to quit from ChimeraX after executing the command (default false).
devel clean  path  [ exit  true | false ]
Remove build files from path (or a name previously defined with devel alias). The exit option indicates whether to quit from ChimeraX after executing the command (default false).
devel dump path
Log the metadata for the bundle at path (or a name previously defined with devel alias).
devel install  path  [ debug  true | false ] [ noDeps  true | false ] [ user  true | false ] [ exit  true | false ] [ editable  true | false ]
Install the bundle at path (or a name previously defined with devel alias), building it first if necessary. The debug option indicates whether to build any compiled extensions with debugging information (default false). If user is true, the bundle will be installed into the user's package directory instead of the internal ChimeraX directory. If editable is true, the bundle will be installed so that changes to Python files take effect the next time ChimeraX restarts, but changes to metadata (bundle_info.xml or pyproject.toml) or to compiled extensions still require a reinstall. The exit option indicates whether to quit from ChimeraX after executing the command (default false).
devel pip [ pip-arguments ]
The command devel pip is the same as pip (not yet documented).

UCSF Resource for Biocomputing, Visualization, and Informatics / February 2025