This Section is for end users who need to run the DRC and RiverWare through the UCRAF Toolbox in ArcGIS Pro.

Users do not need to modify code or data, only download approved versions and run tools.

Note, it is possible to perform all the necessary functions outside of an ArcGIS environment, however, the process is more involved and requires a standalone Python environment. 

Contents

Prerequisites

Before starting, you should already have:

• ArcGIS Pro

• RiverWare

• Access to the UCRAF Git repository

• OAuth credentials from the project maintainer:

  • OAuth Client ID

  • OAuth Client Secret

Step 1 — Install Git (One Time)

Git is used only to download and update the UCRAF code.

1. Download Git for Windows:
   https://git-scm.com/download/win

2. Run the installer.

3. Accept all default options.

After installation, you will have Git Bash available in the Start Menu.

Step 2 — Install DVC (One Time)

DVC is used to download all the supporting data.

1. Download the Windows DVC executable from:
   https://doc.dvc.org/install/windows#windows-installer

2. Run the Installer

   • Double-click the downloaded installer.

   • You will see the DVC Setup Wizard.

   • Click Next.

   • Accept the default options

   • Complete the installation.

   • You do not need to customize anything.
     The installer automatically adds DVC to your system PATH.

3. Verify the Installation

   •  Open Git Bash (Start Menu → Git → Git Bash).

   • Run:
     dvc --version

   • You should see a version number (for example, 3.x.x).

   • If you see a version number, DVC is installed correctly.

If Something Goes Wrong

• If dvc --version is not recognized:

  • Close Git Bash

  • Reopen Git Bash

  • Try again

• If it still fails, restart your computer and retry.

Important Notes

• You do not need Python to use DVC.

• You do not need Anaconda.

• Do not install DVC into the ArcGIS Pro Python environment.

• DVC is only used to download data, not to run ArcGIS tools.

Step 3 — Clone the UCRAF Repository 

DVC is used only to download the supporting data.

1. Decide where the project should live ( for example):
   C:/Projects/UCRAF_ControlTool

2. Open Git Bash 

3. Set the directory to the parent folder:
   cd C:/Projects

4. Clone the repository:
   git clone https://github.com/wahl-59/UCRAF_ControlTool.git

5.  Enter the project folder:
   cd UCRAF_ControlTool

Step 4 — Configure DVC Authentication (One Time) 

Because of Google Workspace security rules, DVC requires an approved OAuth client. 

1. Obtain the following from the project maintainer: 

   • OAuth Client ID 

   • OAuth Client Secret

2. From inside the repository folder, run (be sure to substitute the CLIENT_ID and CLIENT_SECRET provided to you by the data maintainer):
   dvc remote modify --local gdrive gdrive_client_id "<CLIENT_ID>"
   dvc remote modify --local gdrive gdrive_client_secret "<CLIENT_SECRET>"
   
   These credentials are:

   • stored only on your computer

   • not committed to Git

   • not shared with other users

Step 5 — Download the Input Data 

From the repository folder:
dvc pull

On the first run:

• a browser window will open

• log in with your approved Google account

• click Allow

DVC will download all required datasets.

After completion, your folder will contain:
UCRAF_ControlTool/
UCRAF_data/
GIS/
tabular/

Step 6 — Install UCRAF Toolbox

1. Open a new project in ArcGIS Pro

2. Add the toolbox:

• Catalog pane → right click on... "Toolboxes"

• Navigate to: C:/Projects/UCRAF_ControlTool/ArcGIS/ArcToolbox/

• Select: UCRAF.atbx and hit 'OK'.

The UCRAF Toolbox should now appear in the 'Catalog Pane'. 

Regular Day-to-Day Use

For code-only updates:

“Update available... With ArcGIS closed, from within your local "UCRAF_ControlTool" run git pull and (recommended) dvc pull, then reopen ArcGIS Pro.”

For data updates:

“Data + code updated... Run git pull then dvc pull -f.”

This ensures:

• you have the latest tools and models

• you have the latest approved datasets

Full Maintainer Workflow: 

Before starting work, run the following commands:
dvc add UCRAF_data
git add UCRAF_data.dvc
git commit -m "Refresh UCRAF input data (YYYY-MM-DD)"
set PYTHONUTF8=1
dvc push
git push

After any remote migration or big data refresh (recommended check)
dvc status -c

You want it to show nothing missing / nothing to push. That means you have the latest approved datasets.

Maintainer Guide

NEXT: Configure the Python Environment