Merge branch 'ABM3_develop' of https://github.com/SANDAG/ABM into ABM…

…3_develop

.github/workflows/docs.yml

@@ -0,0 +1,22 @@
+name: Publish documents
+on:
+  push:
+    branches: [main, ABM3_develop]
+jobs:
+  build:
+    name: Deploy docs to GitHub Pages
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout 
+        uses: actions/checkout@v2
+      - name: Build
+        uses: Tiryoh/actions-mkdocs@v0
+        with:
+          mkdocs_version: 'latest' 
+          requirements: 'docs_requirements.txt'
+          configfile: 'mkdocs.yml'
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./site

.gitignore

@@ -46,4 +46,8 @@ src/asim/configs_mp/settings.yaml
 src/main/resources/pskill.exe
 
 # VS Code
-.vscode
+.vscode
+
+src/asim-cvm/data/
+src/asim-cvm/output/
+src/asim-cvm/data/maz.csv

build.cmd

@@ -66,6 +66,10 @@ xcopy /Y/S/E .\src\main\emme %ROOT%\common\python\emme
 if not exist %ROOT%\common\src\asim mkdir %ROOT%\common\src\asim
 xcopy /Y/S/E .\src\asim %ROOT%\common\src\asim
 
+@REM Copy CVM files
+if not exist %ROOT%\common\src\asim-cvm mkdir %ROOT%\common\src\asim-cvm
+xcopy /Y/S/E .\src\asim-cvm %ROOT%\common\src\asim-cvm
+
 @REM get git info
 @echo get git info
 set GIT_FOLDER=.\.git

docs/README.md

@@ -0,0 +1,23 @@
+# Instructions for Editing/Managing Documentation
+
+TODO: update/refine as needed
+
+## Getting Started
+
+To get started using Anaconda, do the following:
+
+```
+conda create -n rsm_docs python=3.10
+conda activate rsm_docs
+pip install -r docs_requirements.txt
+```
+
+To create the website locally:
+
+```
+mkdocs serve
+```
+
+See the `mkdocs.yml` file for the configuration.
+
+To create the website on GitHub pages, see the .github/workflows/docs.yml

docs/design.md

@@ -0,0 +1,8 @@
+## Introduction
+
+Activity-Based Model 3 (ABM3) is a new activity-based model system implemented in the ActivitySim software.
+
+The ABM3 design is shown below
+
+reference to design
+

docs/index.md

@@ -0,0 +1,6 @@
+# SANDAG ABM3
+
+Welcome to the SANDAG Activity-Based Travel Model documentation site!
+
+
+## Introduction

docs/inputsandoutputs.md

@@ -0,0 +1,11 @@
+## Inputs and Outputs
+
+The main inputs to ABM3 include the transportation network, land-use data, synthetic population data, parameters files, and model specifications. Outputs include a set of files that describe travel decisions made by all travel markets considered by the model (residents, overnight visitors, airport ground access trips, commercial vehicles and trucks, Mexico residents traveling in San Diego County, and travel made by all other non-residents into and through San Diego County.
+
+# Model Inputs
+
+List here
+
+# Model Outputs
+
+List here

docs/running.md

@@ -0,0 +1,16 @@
+## Installing and Running ABM3
+
+This page describes how to install and run ABM3
+
+# System Requirements
+
+
+# Software Requirements
+
+
+# Installing ABM3 Model
+
+
+
+# The ABM3 GUI
+

docs_requirements.txt

@@ -0,0 +1,15 @@
+fontawesome_markdown
+json5
+jsonschema
+Markdown
+markdown-it-py
+mike
+mkdocs
+mkdocs-autorefs
+mkdocs-awesome-pages-plugin
+mkdocs-jupyter
+mkdocs-material
+mkdocs-material-extensions
+mkdocstrings
+mkdocstrings-python
+mkdocs-table-reader-plugin