The verdi command line interface.
verdi archive command.
aiida.cmdline.commands.cmd_archive.
ExtrasImportCode
Bases: enum.Enum
enum.Enum
Exit codes for the verdi command line.
__module__
ask
keep_existing
mirror
none
update_existing
_echo_exception
Correctly report and exception.
msg – The message prefix
exception – the exception raised
warn_only – If True only print a warning, otherwise calls sys.exit with a non-zero exit status
_gather_imports
Gather archives to import and sort into local files and URLs.
list of (archive path, whether it is web based)
_import_archive
Perform the archive import.
archive – the path or URL to the archive
web_based – If the archive needs to be downloaded first
import_kwargs – keyword arguments to pass to the import function
try_migration – whether to try a migration if the import raises IncompatibleArchiveVersionError
verdi calcjob commands.
verdi code command.
aiida.cmdline.commands.cmd_code.
get_computer_name
get_default
Get the default argument using a user instance property :param value: The name of the property to use :param ctx: The click context (which will be used to get the user) :return: The default value, or None
get_on_computer
print_list_res
Print a list of available codes.
set_code_builder
Set the code spec for defaults of following options.
verdi comment command.
verdi completioncommand command, to return the string to insert into the bash script to activate completion.
verdi computer command.
aiida.cmdline.commands.cmd_computer.
_computer_create_temp_file
Internal test to check if it is possible to create a temporary file and then delete it in the work directory
exceptions could be raised
transport – an open transport
scheduler – the corresponding scheduler class
authinfo – the AuthInfo object (from which one can get computer and aiidauser)
tuple of boolean indicating success or failure and an optional string message
_computer_get_remote_username
Internal test to check if it is possible to determine the username on the remote.
authinfo – the AuthInfo object
_computer_test_get_jobs
Internal test to check if it is possible to check the queue state.
_computer_test_no_unexpected_output
Test that there is no unexpected output from the connection.
This can happen if e.g. there is some spurious command in the .bashrc or .bash_profile that is not guarded in case of non-interactive shells.
get_computer_names
Retrieve the list of computers in the DB.
get_parameter_default
Get the value for a specific parameter from the computer_builder or the default value of that option
parameter – parameter name
ctx – click context of the command
parameter default value, or None
prompt_for_computer_configuration
set_computer_builder
Set the computer spec for defaults of following options.
verdi config command.
aiida.cmdline.commands.cmd_config.
_DeprecateConfigCommandsGroup
Bases: click.core.Group
click.core.Group
Overloads the get_command with one that identifies deprecated commands.
get_command
Override the default click.Group get_command with one that identifies deprecated commands.
verdi daemon commands.
aiida.cmdline.commands.cmd_daemon.
validate_daemon_workers
Validate the value for the number of daemon workers to start with default set by config.
verdi database commands.
verdi devel commands.
verdi export command.
verdi graph commands
verdi group commands
Command for verdi help.
verdi import command.
verdi node command.
aiida.cmdline.commands.cmd_node.
echo_node_dict
Show the attributes or extras of one or more nodes.
Command for verdi plugins.
verdi process command.
aiida.cmdline.commands.cmd_process.
process_actions
Process the requested actions sent to a set of Processes given a map of the futures and the corresponding processes. This function will echo the correct information strings based on the outcomes of the futures and the given verb conjugations. You can optionally wait for any pending actions to be completed before the functions returns and use a timeout to put a maximum wait time on the actions.
futures_map (dict) – the map of action futures and the corresponding processes
infinitive (str) – the infinitive form of the action verb
present (str) – the present tense form
past (str) – the past tense form
wait (bool) – if True, waits for pending actions to be competed, otherwise just returns
timeout (float) – the timeout (in seconds) to wait for actions to be completed
verdi profile command.
verdi rehash command.
This allows to hook-up the AiiDA built-in RESTful API. Main advantage of doing this by means of a verdi command is that different profiles can be selected at hook-up (-p flag).
verdi run command.
aiida.cmdline.commands.cmd_run.
update_environment
Context manager that temporarily replaces sys.argv with argv and adds current working dir to the path.
validate_entrypoint_string
Validate that value is a valid entrypoint string.
The verdi setup and verdi quicksetup commands.
The verdi shell command
verdi status command.
aiida.cmdline.commands.cmd_status.
ServiceStatus
Bases: enum.IntEnum
enum.IntEnum
Describe status of services for ‘verdi status’ command.
DOWN
ERROR
UP
WARNING
print_status
Print status message.
Includes colored indicator.
status – a ServiceStatus code
service – string for service name
msg – message string
verdi user command.
aiida.cmdline.commands.cmd_user.
get_user_attribute_default
Return the default value for the given attribute of the user passed in the context.
attribute – attribute for which to get the current value
ctx – click context which should contain the selected user
user attribute default value if set, or None
set_default_user
Set the user as the default user for the given profile.
profile – the profile
user – the user
The main verdi click group.
aiida.cmdline.commands.cmd_verdi.
MostSimilarCommandGroup
Overloads the get_command to display a list of possible command candidates if the command could not be found with an exact match.
Override the default click.Group get_command with one giving the user a selection of possible commands if the exact command name could not be found.