Installation

NOTE: The installation instruction below assume that you have python installed on your machine and are using conda as your package/environment manager.

Option 1: Install from PIP (recommended for analysts):

1. Create a new environment:

   conda create --name rev python=3.11

2. Activate directory:

   conda activate rev

3. Install reV:

   1. pip install NLR-reV or

      • NOTE: If you install using conda and want to use HSDS you will also need to install HSDS dependencies: pip install NLR-reV[hsds]

      • NOTE: If you intend to use the bespoke module, be sure to install the bespoke-specific dependencies: pip install NLR-reV[bespoke]

Option 2: Clone repo (recommended for developers)

1. from home dir, git clone git@github.com:NatLabRockies/reV.git

2. Create reV environment and install package

   1. Create a conda env: conda create -n rev

   2. Run the command: conda activate rev

   3. cd into the repo cloned in 1.

   4. prior to running pip below, make sure the branch is correct (install from main!)

   5. Install reV and its dependencies by running: pip install . (or pip install -e . if running a dev branch or working on the source code)

      • NOTE: If you intend to work on reV development, be sure to grab all the dependencies: pip install -e ".[bespoke,dev,test,doc,hsds,build]"

3. Check that reV was installed successfully

   1. From any directory, run the following commands. This should return the help pages for the CLI’s.

      • reV

Command Line Tools

• reV

• reV template-configs

• reV batch

• reV pipeline

• reV project-points

• reV bespoke

• reV generation

• reV econ

• reV collect

• reV multiyear

• reV supply-curve-aggregation

• reV supply-curve

• reV rep-profiles

• reV hybrids

• reV nrwal

• reV qa-qc

• reV script

• reV status

• reV reset-status