qanat document¶

Command information¶

qanat document¶

Document-level utility

qanat document [OPTIONS] COMMAND [ARGS]...

add_dependency¶

Add dependency to document.

qanat document add_dependency [OPTIONS] [DOCUMENT_NAME] [EXPERIMENT_NAME]
                              [RUN_ARGS_FILE] [FILES]...

Options

--runner <runner>¶: Runner to use for running the experiment.

--runner_params <runner_params>¶: Parameters to pass to the runner.

--container <container>¶: Container to use for running the experiment.

--commit_sha <commit_sha>¶: Commit SHA to use for running the experiment.

--yes¶: Skip confirmation prompt.

Arguments

DOCUMENT_NAME¶: Optional argument

EXPERIMENT_NAME¶: Optional argument

RUN_ARGS_FILE¶: Optional argument

FILES¶: Optional argument(s)

compile¶

Compile document.

qanat document compile [OPTIONS] NAME

Options

--options <options>¶: Options to pass to the compiler as str.

--view¶: View document after compilation.

Arguments

NAME¶: Required argument

delete¶

Delete document.

qanat document delete [OPTIONS] NAME

Arguments

NAME¶: Required argument

delete_dependency¶

Delete dependency from document.

qanat document delete_dependency [OPTIONS] [DOCUMENT_NAME] [EXPERIMENT_NAME]
                                 [RUN_ARGS_FILE]

Arguments

DOCUMENT_NAME¶: Optional argument

EXPERIMENT_NAME¶: Optional argument

RUN_ARGS_FILE¶: Optional argument

list¶

Show list of documents in this repertory.

qanat document list [OPTIONS]

new¶

Create new document.

DESCRIPTION_FILE is a file containing the description of the document. If not provided, a prompt will ask for the description.

qanat document new [OPTIONS]

Options

-f, --file <file>¶: Path to a YAML file containing the document definition.

status¶

Show status of document.

qanat document status [OPTIONS] NAME

Arguments

NAME¶: Required argument

update¶

Update document.

qanat document update [OPTIONS] NAME

Arguments

NAME¶: Required argument

view¶

View document.

qanat document view [OPTIONS] NAME

Arguments

NAME¶: Required argument

Command description¶

This command is used to manage documents, notably you can specify experiment dependecies to compile document if an experiment has been run and copy the files automatically to the document directory.