reVeal

reVeal Command Line Interface.

Typically, a good place to start is to set up a reVeal job with a pipeline config that points to several reVeal modules that you want to run in serial.

To begin, you can generate some template configuration files using:

$ reVeal template-configs

By default, this generates template JSON configuration files, though you can request JSON5, YAML, or TOML configuration files instead. You can run $ reVeal template-configs --help on the command line to see all available options for the template-configs command. Once the template configuration files have been generated, you can fill them out by referring to the module CLI documentation (if available) or the help pages of the module CLIs for more details on the config options for each CLI command:

$ reVeal --help

$ reVeal characterize --help

$ reVeal normalize --help

$ reVeal score-weighted --help

$ reVeal downscale --help

$ reVeal script --help

After appropriately filling our the configuration files for each module you want to run, you can call the reVeal pipeline CLI using:

$ reVeal pipeline -c config_pipeline.json

This command will run each pipeline step in sequence.

Note

You will need to re-submit the pipeline command above after each completed pipeline step.

To check the status of the pipeline, you can run:

$ reVeal status

This will print a report to the command line detailing the progress of the current pipeline. See $ reVeal status --help for all status command options.

If you need to parameterize the pipeline execution, you can use the batch command. For details on setting up a batch config file, see the documentation or run:

$ reVeal batch --help

on the command line. Once you set up a batch config file, you can execute it using:

$ reVeal batch -c config_batch.json

For more information on getting started, see the How to Run a Model Powered by GAPs guide.

The general structure of the reVeal CLI is given below.

Usage

reVeal [OPTIONS] COMMAND [ARGS]...

Options

-v, --verbose

Flag to turn on debug logging. Default is not verbose.

--version

Show the version and exit.