vara-art

This tool manages the Artefacts of a paper config.

usage: vara-art [-h] {list,show,generate,add} ...

positional arguments:
  {list,show,generate,add}
                        Subcommand
    list                List all artefacts of the current paper config.
    show                Show detailed insformation about artefacts.
    generate            Generate artefacts. By default, all artefacts are
                        generated.
    add                 Add a new artefact to the current paper config or edit
                        an existing artefacts.

optional arguments:
  -h, --help            show this help message and exit

The subcommand vara-art add adds a new artefact to the current paper config.

usage: vara-art add [-h] [--output-path OUTPUT_PATH] {plot,table} name ...

positional arguments:
  {plot,table}          The type of the new artefact.
  name                  The name for the new artefact. If an artefact with
                        this name already exists, it is overridden.
  KEY=VALUE             Provide additional arguments that will be passed to
                        the class that generates the artefact. (do not put
                        spaces before or after the '=' sign). If a value
                        contains spaces, you should define it with double
                        quotes: foo="bar baz".

optional arguments:
  -h, --help            show this help message and exit
  --output-path OUTPUT_PATH
                        The output file for the new artefact. This is relative
                        to `artefacts_dir/current_config` from the current
                        `.varats.yml`.

For example, an artefact that will generate a paper_config_overview_plot (see plots) for the current paper config can be added via:

vara-art add plot "overview plot" report_type=EmptyReport plot_type=paper_config_overview_plot

Note

The double quotes around the artefact name are only needed if the name contains spaces or other characters with special meaning.

To generate all artefacts of the current paper-config, use:

vara-art generate

If you only want to generate some specific artefacts, you can specify their names with the --only parameter:

vara-art generate --only "overview plot"

You can list all artefacts of the current paper config with:

vara-art list

To show details for one or more artefacts, use:

vara-art show "overview plot"

You can give multiple artefact names to vara-art show to see details for multiple artefacts at once.