reV

reV Command Line Interface.

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

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

$ reV template-configs

By default, this generates template JSON configuration files, though you can request JSON5, YAML, or TOML configuration files instead. You can run $ reV 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:

$ reV --help

$ reV bespoke --help

$ reV generation --help

$ reV econ --help

$ reV collect --help

$ reV multi-year --help

$ reV supply-curve-aggregation --help

$ reV supply-curve --help

$ reV rep-profiles --help

$ reV hybrids --help

$ reV nrwal --help

$ reV qa-qc --help

$ reV script --help

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

$ reV 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:

$ reV status

This will print a report to the command line detailing the progress of the current pipeline. See $ reV 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:

$ reV batch --help

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

$ reV 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 reV CLI is given below.

reV [OPTIONS] COMMAND [ARGS]...

Options

-v, --verbose

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

--version

Show the version and exit.