From f06a2489c661706a90a26a0fb55e5aa3250d531e Mon Sep 17 00:00:00 2001
From: em rexer <13180883+erexer@users.noreply.github.com>
Date: Tue, 9 Apr 2024 09:49:10 -0700
Subject: [PATCH] update quickstarter, fix codecov (#163)

* update quickstarter with dagworks platform instructions

* update quickstarter with graphviz instructions, clearer wording

* add codecov token, update codecov version
---
 .github/workflows/build.yml  |  4 +++-
 docs/source/quickstarter.rst | 37 ++++++++++++++++++++++++------------
 2 files changed, 28 insertions(+), 13 deletions(-)

diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
index 56dcd2469a..aefe130b00 100644
--- a/.github/workflows/build.yml
+++ b/.github/workflows/build.yml
@@ -41,7 +41,9 @@ jobs:
             pip install pytest-cov
             pytest --cov=naturf/ --cov-report=xml
         - name: Upload coverage to Codecov
-          uses: codecov/codecov-action@v3
+          uses: codecov/codecov-action@v4
+          env:
+            CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
           with:
             file: ./coverage.xml
             fail_ci_if_error: true
diff --git a/docs/source/quickstarter.rst b/docs/source/quickstarter.rst
index becafb5898..06d879fcbe 100644
--- a/docs/source/quickstarter.rst
+++ b/docs/source/quickstarter.rst
@@ -8,7 +8,7 @@ Input data
 
 The only input data required for `naturf` is a shapefile with building footprints and height data. There should be a field with a unique ID for each building the shapefile, and it should be in a projected coordinate system such as Alber Equal Area Conic. For input to the Weather Research and Forecasting model (WRF), the computed parameters for each building will be projected into WGS 84.
 
-Either check out our interactive `quickstarter <quickstarter.rst>`_, or continue below to run `naturf` using a python file.
+Either check out our interactive `quickstarter <quickstarter.rst>`_, or continue below to run `naturf` using a python file. Users need to have `graphviz <https://graphviz.org/download/>`_ installed to visualize the Directed Acyclic Graph (DAG).
 
 1. Install `naturf`
 -------------------
@@ -17,7 +17,7 @@ In a clean virtual or Conda environment, install `naturf`. NOTE: For Conda envir
 
 .. code:: bash
 
-    pip install naturf
+    $ pip install naturf
 
 2. Edit config variables and create run script
 ----------------------------------------------
@@ -68,20 +68,28 @@ This will run all functions required to create the output specified in the `run.
 
 .. code:: bash
 
-    python run.py
+    $ python run.py
 
 
 Run using the `DAGWorks Platform <app.dagworks.io>`_
 ----------------------------------------------------
 
-Import os and the DAGWorks Tracker:
+Set the DAGWorks API Key as an environment variable:
+
+.. code:: bash
+
+    $ export DAGWORKS_API_KEY="<your API Key>"
+
+
+Start with the `run.py` file from above (using either the example data or your own data) and add the following. Import os and DAGWorks adapters, which contains the tracker:
 
 .. code:: python3
 
     import os
     from dagworks import adapters
 
-Add this to `run.py` at the top of main:
+
+Initialize the DAGWorks tracker:
 
 .. code:: python3
 
@@ -90,16 +98,11 @@ Add this to `run.py` at the top of main:
             api_key=os.environ["DAGWORKS_API_KEY"],
             username="<your username>",
             dag_name="<name of the DAG>",
-            tags={"environment": "DEV", "team": "MY_TEAM", "version": "X"}
+            tags={"environment": "DEV", "team": "MY_TEAM", "version": "X"},
         )
 
-Set the API Key as an environment variable:
-
-.. code:: bash
-
-    $ export DAGWORKS_API_KEY="<your API Key>"
 
-Add `tracker` in the `hamilton_adaptors` list:
+Add `tracker` to the `hamilton_adaptors` list:
 
 .. code:: python3
 
@@ -108,3 +111,13 @@ Add `tracker` in the `hamilton_adaptors` list:
                 h_tqdm.ProgressBar("Naturf DAG"),
                 tracker,
             ]
+
+
+Run the python file!
+
+.. code:: bash
+
+    $ python run.py
+
+
+You should see a run on the `DAGWorks Platform <app.dagworks.io>`_!