Merge pull request #8 from VisionEval/main

Sync with the main FHWA repo

.github/workflows/copy_book.yml

@@ -1,25 +1,27 @@
 name: Copy Book To VE.Org
 
-on: push
+on:
+  push:
+    branches:
+      - main
 
 jobs:
   copy-book-dir:
     runs-on: ubuntu-latest
     steps:
     - name: Checkout
-      uses: actions/checkout@v2
+      uses: actions/checkout@v4
       with:
-          ref: ${{ github.head_ref }} 
+          ref: main
 
-    - name: Copies all contents to VE.org
+    - name: Copy contents to VisionEval/VisionEval.github.io
       uses: cpina/[email protected]
-
       env:
         API_TOKEN_GITHUB: ${{ secrets.docs_sync }}
       with:
         source-directory: 'docs/'
         target-directory: 'docs/'
         destination-github-username: 'VisionEval'
-        destination-repository-name: 'VisionEval.org'
-        user-email: 'daniel.flynn@dot.gov'
-        target-branch: 'main'
+        destination-repository-name: 'VisionEval.github.io'
+        user-email: 'visioneval@dot.gov'
+        target-branch: 'main'

README.md

@@ -2,6 +2,11 @@
 
 Documentation for the VisionEval project
 
-`concept_primer` contains a Bookdown-formatted documentation which describes the key concepts of the VisionEval project.
+`user_guide` contains Bookdown-formatted documentation for all aspects of the VisionEval project.
 
-`user_guide` contains Bookdown-formatted documentation for all aspects of the VisionEval project.
+`docs` contains the Bookdown-generated output from building the `user_guide`. A workflow moves
+this folder over to the `docs` subfolder in the trunk (master) branch of
+[VisionEval.org](https://github.com/VisionEval/VisionEval.org)
+
+The rendered version of the docs are synced to the GitHub pages site and published at
+https://VisionEval.github.io/docs/

docs/10-build-process.md

@@ -1,4 +1,4 @@
-# VisionEval Module Build Process {\#ve-buildprocess}
+# VisionEval Module Build Process {#ve-buildprocess}
 
     knitr::opts_chunk$set(echo = TRUE, results='hide')
 

docs/api-documentation.html

@@ -62,7 +62,7 @@
 <li><a class="" href="vestate.html"><span class="header-section-number">10</span> VE-State Model Details</a></li>
 <li><a class="" href="verpat.html"><span class="header-section-number">11</span> VERPAT Model Details</a></li>
 <li><a class="" href="ve-estimation.html"><span class="header-section-number">12</span> Estimation in VisionEval</a></li>
-<li><a class="" href="visioneval-module-build-process-ve-buildprocess.html"><span class="header-section-number">13</span> VisionEval Module Build Process {#ve-buildprocess}</a></li>
+<li><a class="" href="ve-buildprocess.html"><span class="header-section-number">13</span> VisionEval Module Build Process</a></li>
 <li><a class="" href="common-use-cases.html"><span class="header-section-number">14</span> Common Use Cases</a></li>
 <li><a class="active" href="api-documentation.html"><span class="header-section-number">15</span> API Documentation</a></li>
 <li><a class="" href="software-framework.html"><span class="header-section-number">16</span> Software Framework</a></li>
@@ -102,7 +102,7 @@ <h1>
 <footer class="bg-primary text-light mt-5"><div class="container"><div class="row">
 
   <div class="col-12 col-md-6 mt-3">
-    <p>"<strong>VisionEval User Guide</strong>" was written by VisionEval Pooled Fund Team. It was last built on 2023-09-20.</p>
+    <p>"<strong>VisionEval User Guide</strong>" was written by VisionEval Pooled Fund Team. It was last built on 2023-12-07.</p>
   </div>
 
   <div class="col-12 col-md-6 mt-3">

docs/conceptprimer.html

@@ -62,7 +62,7 @@
 <li><a class="" href="vestate.html"><span class="header-section-number">10</span> VE-State Model Details</a></li>
 <li><a class="" href="verpat.html"><span class="header-section-number">11</span> VERPAT Model Details</a></li>
 <li><a class="" href="ve-estimation.html"><span class="header-section-number">12</span> Estimation in VisionEval</a></li>
-<li><a class="" href="visioneval-module-build-process-ve-buildprocess.html"><span class="header-section-number">13</span> VisionEval Module Build Process {#ve-buildprocess}</a></li>
+<li><a class="" href="ve-buildprocess.html"><span class="header-section-number">13</span> VisionEval Module Build Process</a></li>
 <li><a class="" href="common-use-cases.html"><span class="header-section-number">14</span> Common Use Cases</a></li>
 <li><a class="" href="api-documentation.html"><span class="header-section-number">15</span> API Documentation</a></li>
 <li><a class="" href="software-framework.html"><span class="header-section-number">16</span> Software Framework</a></li>
@@ -1369,7 +1369,7 @@ <h3>
 <footer class="bg-primary text-light mt-5"><div class="container"><div class="row">
 
   <div class="col-12 col-md-6 mt-3">
-    <p>"<strong>VisionEval User Guide</strong>" was written by VisionEval Pooled Fund Team. It was last built on 2023-09-20.</p>
+    <p>"<strong>VisionEval User Guide</strong>" was written by VisionEval Pooled Fund Team. It was last built on 2023-12-07.</p>
   </div>
 
   <div class="col-12 col-md-6 mt-3">

docs/developing-scenarios.html

@@ -62,7 +62,7 @@
 <li><a class="" href="vestate.html"><span class="header-section-number">10</span> VE-State Model Details</a></li>
 <li><a class="" href="verpat.html"><span class="header-section-number">11</span> VERPAT Model Details</a></li>
 <li><a class="" href="ve-estimation.html"><span class="header-section-number">12</span> Estimation in VisionEval</a></li>
-<li><a class="" href="visioneval-module-build-process-ve-buildprocess.html"><span class="header-section-number">13</span> VisionEval Module Build Process {#ve-buildprocess}</a></li>
+<li><a class="" href="ve-buildprocess.html"><span class="header-section-number">13</span> VisionEval Module Build Process</a></li>
 <li><a class="" href="common-use-cases.html"><span class="header-section-number">14</span> Common Use Cases</a></li>
 <li><a class="" href="api-documentation.html"><span class="header-section-number">15</span> API Documentation</a></li>
 <li><a class="" href="software-framework.html"><span class="header-section-number">16</span> Software Framework</a></li>
@@ -331,7 +331,7 @@ <h3>
 <footer class="bg-primary text-light mt-5"><div class="container"><div class="row">
 
   <div class="col-12 col-md-6 mt-3">
-    <p>"<strong>VisionEval User Guide</strong>" was written by VisionEval Pooled Fund Team. It was last built on 2023-09-20.</p>
+    <p>"<strong>VisionEval User Guide</strong>" was written by VisionEval Pooled Fund Team. It was last built on 2023-12-07.</p>
   </div>
 
   <div class="col-12 col-md-6 mt-3">

docs/getting-started.html

@@ -62,7 +62,7 @@
 <li><a class="" href="vestate.html"><span class="header-section-number">10</span> VE-State Model Details</a></li>
 <li><a class="" href="verpat.html"><span class="header-section-number">11</span> VERPAT Model Details</a></li>
 <li><a class="" href="ve-estimation.html"><span class="header-section-number">12</span> Estimation in VisionEval</a></li>
-<li><a class="" href="visioneval-module-build-process-ve-buildprocess.html"><span class="header-section-number">13</span> VisionEval Module Build Process {#ve-buildprocess}</a></li>
+<li><a class="" href="ve-buildprocess.html"><span class="header-section-number">13</span> VisionEval Module Build Process</a></li>
 <li><a class="" href="common-use-cases.html"><span class="header-section-number">14</span> Common Use Cases</a></li>
 <li><a class="" href="api-documentation.html"><span class="header-section-number">15</span> API Documentation</a></li>
 <li><a class="" href="software-framework.html"><span class="header-section-number">16</span> Software Framework</a></li>
@@ -407,7 +407,7 @@ <h2>
 <footer class="bg-primary text-light mt-5"><div class="container"><div class="row">
 
   <div class="col-12 col-md-6 mt-3">
-    <p>"<strong>VisionEval User Guide</strong>" was written by VisionEval Pooled Fund Team. It was last built on 2023-09-20.</p>
+    <p>"<strong>VisionEval User Guide</strong>" was written by VisionEval Pooled Fund Team. It was last built on 2023-12-07.</p>
   </div>
 
   <div class="col-12 col-md-6 mt-3">

docs/index.html

@@ -62,7 +62,7 @@
 <li><a class="" href="vestate.html"><span class="header-section-number">10</span> VE-State Model Details</a></li>
 <li><a class="" href="verpat.html"><span class="header-section-number">11</span> VERPAT Model Details</a></li>
 <li><a class="" href="ve-estimation.html"><span class="header-section-number">12</span> Estimation in VisionEval</a></li>
-<li><a class="" href="visioneval-module-build-process-ve-buildprocess.html"><span class="header-section-number">13</span> VisionEval Module Build Process {#ve-buildprocess}</a></li>
+<li><a class="" href="ve-buildprocess.html"><span class="header-section-number">13</span> VisionEval Module Build Process</a></li>
 <li><a class="" href="common-use-cases.html"><span class="header-section-number">14</span> Common Use Cases</a></li>
 <li><a class="" href="api-documentation.html"><span class="header-section-number">15</span> API Documentation</a></li>
 <li><a class="" href="software-framework.html"><span class="header-section-number">16</span> Software Framework</a></li>
@@ -110,7 +110,7 @@ <h1>Welcome<a class="anchor" aria-label="anchor" href="#welcome"><i class="fas f
 <td align="left">Overview of model estimation in VisionEval and instructions to customize model applications</td>
 </tr>
 <tr class="even">
-<td align="left">[Module Build Process][Module Build Process]</td>
+<td align="left"><a href="ve-buildprocess.html#ve-buildprocess">Module Build Process</a></td>
 <td align="left">Overview of building a VisionEval package module using custom data</td>
 </tr>
 <tr class="odd">
@@ -188,7 +188,7 @@ <h2>How to Use this Guide<a class="anchor" aria-label="anchor" href="#how-to-use
 <footer class="bg-primary text-light mt-5"><div class="container"><div class="row">
 
   <div class="col-12 col-md-6 mt-3">
-    <p>"<strong>VisionEval User Guide</strong>" was written by VisionEval Pooled Fund Team. It was last built on 2023-09-20.</p>
+    <p>"<strong>VisionEval User Guide</strong>" was written by VisionEval Pooled Fund Team. It was last built on 2023-12-07.</p>
   </div>
 
   <div class="col-12 col-md-6 mt-3">

docs/index.md

@@ -1,7 +1,7 @@
 --- 
 title: "VisionEval User Guide"
 author: "VisionEval Pooled Fund Team"
-date: "2023-09-20"
+date: "2023-12-07"
 site: bookdown::bookdown_site
 documentclass: book
 bibliography: [book.bib, packages.bib]
@@ -23,7 +23,7 @@ This guide contains documentation for users and developers of the VisionEval mod
 | [VisionEval Tutorial](#tutorial) | Introductory tutorial on how to start applying a VisionEval model, with chapters on [picking a model](#picking-a-model), [model geography](#model-geography-and-years), [inputs](#model-inputs), [validation](#validation-and-troubleshooting), and [scenarios](#developing-scenarios) |
 | VisionEval Model Details | Comprehensive and in-depth documentation on the three VisionEval models: [VERSPM](#verspm), [VE-State](#vestate), and [VERPAT](#verpat) |
 | [Estimation in VisionEval][Estimation in VisionEval] | Overview of model estimation in VisionEval and instructions to customize model applications |
-| [Module Build Process][Module Build Process] | Overview of building a VisionEval package module using custom data |
+| [Module Build Process](#ve-buildprocess) | Overview of building a VisionEval package module using custom data |
 | [Developer Documentation](#developer) | Information for developers or researchers interested in making contributions to the VisionEval system |
 | [API Documentation][API Documentation] | Module documentation from the model source code |
 | [Software Framework][Software Framework] | Technical overview of the VisionEval software framework |

docs/model-geography-and-years.html

@@ -62,7 +62,7 @@
 <li><a class="" href="vestate.html"><span class="header-section-number">10</span> VE-State Model Details</a></li>
 <li><a class="" href="verpat.html"><span class="header-section-number">11</span> VERPAT Model Details</a></li>
 <li><a class="" href="ve-estimation.html"><span class="header-section-number">12</span> Estimation in VisionEval</a></li>
-<li><a class="" href="visioneval-module-build-process-ve-buildprocess.html"><span class="header-section-number">13</span> VisionEval Module Build Process {#ve-buildprocess}</a></li>
+<li><a class="" href="ve-buildprocess.html"><span class="header-section-number">13</span> VisionEval Module Build Process</a></li>
 <li><a class="" href="common-use-cases.html"><span class="header-section-number">14</span> Common Use Cases</a></li>
 <li><a class="" href="api-documentation.html"><span class="header-section-number">15</span> API Documentation</a></li>
 <li><a class="" href="software-framework.html"><span class="header-section-number">16</span> Software Framework</a></li>
@@ -390,7 +390,7 @@ <h4>
 <footer class="bg-primary text-light mt-5"><div class="container"><div class="row">
 
   <div class="col-12 col-md-6 mt-3">
-    <p>"<strong>VisionEval User Guide</strong>" was written by VisionEval Pooled Fund Team. It was last built on 2023-09-20.</p>
+    <p>"<strong>VisionEval User Guide</strong>" was written by VisionEval Pooled Fund Team. It was last built on 2023-12-07.</p>
   </div>
 
   <div class="col-12 col-md-6 mt-3">