Merge pull request #215 from SANDAG/docs_update

Documentation: new sections and restructuring

docs/design/airport.md → docs/design/demand/airport.md

@@ -6,7 +6,7 @@ It is important to note that, to work within the ActivitySim framework, the airp
 
 The overall design of the model is shown in the figure below.
 
-![](../images/design/airport_model_design.png)
+![](../../images/design/airport_model_design.png)
 
 1. Tour Enumeration: A list of airport travel parties is generated from input enplanements and transferring passenger rates, as well as distributions that describe the share of travel parties by purpose (business versus personal), household income, and party size.
 2. Tour Level Models

docs/design/crossborder.md → docs/design/demand/crossborder.md

@@ -14,7 +14,7 @@ commercial vehicle model.
 
 The overall design of the model is shown in the figure below.
 
-![](../images/design/crossborder_model_design.png)
+![](../../images/design/crossborder_model_design.png)
 
 #### Crossborder Model Purpose Definitions
 There are five activity purposes in the cross-border travel demand model:

docs/design/demand/external.md

@@ -0,0 +1,7 @@
+# External Models
+
+Details aggregate external models.
+
+## External Internal Model
+
+## External External Model

docs/design/demand/index.md

@@ -0,0 +1,3 @@
+# Demand Design
+
+Details of demand components of the model.

docs/design/resident.md → docs/design/demand/resident.md

@@ -12,7 +12,7 @@ The resident model structure is based on the Coordinated Travel Regional Activit
 
 The resident model design is shown below.
 
-![](../images/design/resident_model_design.png)
+![](../../images/design/resident_model_design.png)
 
 The first model in the sequence is disaggregate accessibilities. This is a recent addition to ActivitySim in which the tour destination choice model is run for a prototypical sample population covering key market segments and destination choice logsums from the model are written out for each tour in the population. These destination choice logsums are then merged with the actual synthetic population and used as accessibility variables in downstream models such as auto ownership, coordinated daily activity patterns, and tour frequency. are mandatory location choice; this model is run for all workers and students regardless of whether they attend work or school on the simulated day.
 

docs/design/visitor.md → docs/design/demand/visitor.md

@@ -2,7 +2,7 @@
 The Overnight Visitor Model simulates trips of visitors staying overnight in hotels, motels, short-term vacation rentals, and with friends and family. The trips are modeled as part of tours that begin and end at the place of lodging. However, unlike the resident model, the Overnight Visitor Model does not utilize a 24-hour activity schedule. Therefore it can be thought of as a simpler, tour-based model. Once each tour is generated, it is scheduled independently. The model uses the same time periods and modes as the resident model.
 The overall design of the model is shown in the figure below.
 
-![](../images/design/visitor_model_design.png)
+![](../../images/design/visitor_model_design.png)
 
 1. Tour Enumeration: A list of visitor parties is generated from the input household data and hotel room inventory at the MGRA level. Visitor travel parties by segment (business versus personal) are calculated based on separate rates for hotels and for households. Visitor parties are generated by purpose based on tour rates by segment, then attributed with household income and party size based on input distributions. There are three purposes in the Overnight Visitor model:
 

docs/design/init/initialization.md

@@ -0,0 +1,20 @@
+# Initialization
+
+## EMME Databases
+
+## Import Network
+
+## Warmup Trip Tables
+
+## Bike Logsums
+
+## Initial Highway Skimming
+
+## Initial Transit Skimming
+
+## Transponder Export
+
+## Scenario Management
+
+## ABM Pre-processing
+

docs/design/report/report.md

@@ -0,0 +1,3 @@
+# Reporting Framework
+
+Details of reporting components.

docs/design/supply/bike-logsums.md

@@ -0,0 +1,3 @@
+# Bike Logsums
+
+Details of bike logsum calculations.

docs/design/supply/highway-skims-assign.md

@@ -0,0 +1,3 @@
+# Highway Skimming and Assignment
+
+Details of highway skimming and assignment.

docs/design/supply/index.md

@@ -0,0 +1,3 @@
+# Supply Design
+
+Details of supply components of the model.

docs/design/supply/network-import-tned.md

@@ -0,0 +1,3 @@
+# Network Import from TNED
+
+Details of importing and processing the ETL network.

docs/design/supply/transit-skims-assign.md

@@ -0,0 +1,3 @@
+# Transit Skimming and Assignment
+
+Details of transit skimming and assignment.

docs/design/supply/walk-skims.md

@@ -0,0 +1,3 @@
+# Walk Skims
+
+Details of walk skim calculations.

mkdocs.yml

@@ -8,10 +8,11 @@ theme:
   name: material
   features:
     - navigation.tabs
-    - content.code.annotate
-    - content.tabs.link
     - navigation.indexes
     - navigation.top
+    - navigation.expand
+    - content.code.annotate
+    - content.tabs.link
   palette:
     - media: "(prefers-color-scheme: light)"
       scheme: default
@@ -50,10 +51,22 @@ nav:
   - Home: index.md
   - Model Design: 
     - Overall Design: design/design.md
-    - Resident: design/resident.md
-    - Crossborder: design/crossborder.md
-    - Airport Ground Access: design/airport.md
-    - Overnight Visitor: design/visitor.md
+    - Initialization: design/init/initialization.md
+    - Demand: 
+        - design/demand/index.md
+        - design/demand/resident.md
+        - design/demand/crossborder.md
+        - design/demand/airport.md
+        - design/demand/visitor.md
+        - design/demand/external.md
+    - Supply: 
+        - design/supply/index.md
+        - design/supply/bike-logsums.md
+        - design/supply/walk-skims.md
+        - design/supply/network-import-tned.md
+        - design/supply/highway-skims-assign.md
+        - design/supply/transit-skims-assign.md
+    - Report: design/report/report.md
   - Installing and Running: running.md
   - Model Inputs and Outputs: 
     - Inputs: inputs.md