From e01086e6e468f4afc068be645364c0fd91c51df8 Mon Sep 17 00:00:00 2001
From: erexer <13180883+erexer@users.noreply.github.com>
Date: Fri, 5 Apr 2024 11:05:03 -0700
Subject: [PATCH] update quickstarter with dagworks platform instructions

---
 docs/source/quickstarter.rst  | 53 ++++++++++++++++++++++++++++++-----
 docs/source/release_notes.rst |  6 ++++
 2 files changed, 52 insertions(+), 7 deletions(-)

diff --git a/docs/source/quickstarter.rst b/docs/source/quickstarter.rst
index ad7391a10d..becafb5898 100644
--- a/docs/source/quickstarter.rst
+++ b/docs/source/quickstarter.rst
@@ -3,15 +3,15 @@ Quickstarter
 ============
 
 
-Data input
+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.
 
-Install `naturf`
------------------
+1. Install `naturf`
+-------------------
 
 In a clean virtual or Conda environment, install `naturf`. NOTE: For Conda environments using Python 3.12, the `setuptools` package does not work as intended. One workaround is to create a Conda environment in Python 3.11.
 
@@ -19,8 +19,8 @@ In a clean virtual or Conda environment, install `naturf`. NOTE: For Conda envir
 
     pip install naturf
 
-Edit config variables and create run script
--------------------------------------------
+2. Edit config variables and create run script
+----------------------------------------------
 
 The `config` module in `naturf` sets the default names for variables used in the `naturf` workflow. The two variables below need to be modified to reflect the ID field and the building height field of the input shapefile. Instructions on changing field names will be given further below.
 
@@ -62,10 +62,49 @@ To run data other than the example data, create the `run.py` below.
     df = model.execute()
     model.graph()
 
-Run `naturf`
-------------
+3. Run `naturf`
+---------------
 This will run all functions required to create the output specified in the `run.py` `output_columns` variable. Currently `write_binary` and `write_index`. The `path` variable should point towards the input shapefile.
 
 .. code:: bash
 
     python run.py
+
+
+Run using the `DAGWorks Platform <app.dagworks.io>`_
+----------------------------------------------------
+
+Import os and the DAGWorks Tracker:
+
+.. code:: python3
+
+    import os
+    from dagworks import adapters
+
+Add this to `run.py` at the top of main:
+
+.. code:: python3
+
+    tracker = adapters.DAGWorksTracker(
+            project_id=<your project ID>,
+            api_key=os.environ["DAGWORKS_API_KEY"],
+            username="<your username>",
+            dag_name="<name of the DAG>",
+            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:
+
+.. code:: python3
+
+    hamilton_adapters = [
+                base.SimplePythonDataFrameGraphAdapter(),
+                h_tqdm.ProgressBar("Naturf DAG"),
+                tracker,
+            ]
diff --git a/docs/source/release_notes.rst b/docs/source/release_notes.rst
index c8dcfc5eb1..3b95ea3c4a 100644
--- a/docs/source/release_notes.rst
+++ b/docs/source/release_notes.rst
@@ -4,6 +4,12 @@ Release notes
 This is the list of changes to **naturf** between each release. For full details,
 see the `commit logs <https://github.com/IMMM-SFA/naturf/commits>`_.
 
+Version 1.0.2
+_____________
+
+- See the `v1.0.2 release notes <https://github.com/IMMM-SFA/naturf/releases/tag/v1.0.2>`_.
+
+
 Version 1.0.1
 _____________