Initial model setup -- Converting SANDAG to ODOT

.github/workflows/ci.yml

@@ -0,0 +1,55 @@
+name: CI Test for Cropped Example
+
+on:
+  push:
+    branches:
+      - '**'
+  pull_request:
+    branches:
+      - '**'
+
+jobs:
+  oregon_metro_cropped_example:
+    strategy:
+      matrix:
+        python-version:
+          - "3.10"
+      fail-fast: false
+
+    name: cropped-example-py${{ matrix.python-version }}
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      # Clone ActivitySim from SimOR_pnr branch
+      - name: Clone ActivitySim
+        run: |
+          cd ..
+          git clone --branch SimOR_pnr https://github.com/RSGInc/activitysim.git
+          pwd
+          ls -la
+
+      # Install UV
+      - name: Install UV
+        uses: astral-sh/setup-uv@v4
+        with:
+          version: "latest"
+
+      # Set up Python with UV
+      - name: Set up Python
+        run: uv python install ${{ matrix.python-version }}
+
+      # Install dependencies using UV and the lock file from ActivitySim
+      - name: Install dependencies with UV
+        run: |
+          cd ../activitysim
+          uv sync --frozen
+          uv pip install -e . --no-deps
+          uv pip list
+
+      # Run the test
+      - name: Run cropped example test
+        run: |
+          cd ../activitysim
+          uv run python $GITHUB_WORKSPACE/resident/test/test_cropped_dataset.py

.gitignore

@@ -0,0 +1,19 @@
+*__pycache__*
+.vscode/*
+resident/model_data/metro/data_full/*
+resident/outputs/*
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.cache
+nosetests.xml
+coverage.xml
+
+Metro_outputs/
+
+skimming_and_assignment/visum/*.ver
+
+# External dependencies managed by setup_environment.bat
+ext_dependencies/*/

.vscode/launch.json

@@ -0,0 +1,52 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "Run Full Example",
+            "type": "debugpy",
+            "request": "launch",
+            "cwd": "${workspaceFolder}/resident",
+            "program": "simulation.py",
+            "console": "integratedTerminal",
+            "args": [
+                "-c", "configs", // check the settings.yaml file for run settings!
+                "-d", "model_data/metro/data_full",
+                "-o", "outputs/full",
+            ]
+        },
+        {
+            "name": "Run Cropped Example",
+            "type": "debugpy",
+            "request": "launch",
+            "cwd": "${workspaceFolder}/resident",
+            "program": "simulation.py",
+            "console": "integratedTerminal",
+            "args": [
+                "-c", "configs", // check the settings.yaml file for run settings!
+                "-d", "model_data/metro/data_cropped",
+                "-o", "outputs/cropped",
+            ]
+        },
+        {
+            "name": "Run Visum_Runner.py",
+            "type": "debugpy",
+            "request": "launch",
+            "cwd": "${workspaceFolder}/skimming_and_assignment/visum",
+            "program": "Visum_Runner.py",
+            "console": "integratedTerminal",
+            "args": ["skims"]
+        },
+        {
+            "name": "Run Preprocessor",
+            "type": "debugpy",
+            "request": "launch",
+            "cwd": "${workspaceFolder}/resident",
+            "program": "preprocessor.py",
+            "console": "integratedTerminal",
+            "args": "preprocessor_settings.yaml"
+        }
+    ]
+}

README.md

@@ -1,3 +1,59 @@
 # SimOR
 Simulate Oregon (SimOR) - Oregon's Jointly Estimated ActivitySim Model
 ![image](SimOR.png)
+
+## Running the model
+
+### Setup
+
+1. **Configure `setup_environment.bat`**
+
+   Open `setup_environment.bat` and set the user-configurable variables at the top of the file:
+
+   | Variable | Description | Default |
+   |----------|-------------|---------|
+   | `VISUM_PYTHON_DIR` | Folder containing your Visum 2026 Python interpreter | `C:\Program Files\PTV Vision\PTV Visum 2026\Exe\Junction_Preview\Python` |
+   | `INSTALL_PARKING` | Clone and install sandag_parking (`Y` or `N`) | `Y` |
+
+   You can run this script on its own to install all dependencies without running the model:
+   ```
+   setup_environment.bat
+   ```
+   It will install UV (if needed), clone and build the required repositories into `ext_dependencies/`, create the MAZ skimming Python environment from `ext_dependencies/maz_skimming/pyproject.toml`, and install the necessary Python packages into Visum's Python environment. On subsequent runs it detects existing installs and pulls the latest changes instead of re-cloning.
+
+2. **Place the Visum version file**
+
+   Copy your Visum network version file (`.ver`) into `skimming_and_assignment/visum/`.
+
+3. **Update configuration files**
+
+   Edit the following files to match your local data paths and project settings:
+
+   | File | Purpose |
+   |------|---------|
+   | `skimming_and_assignment/maz_maz_stop_skims/2zoneSkim_params.yaml` | Non-motorized skim settings and file paths |
+   | `resident/preprocessor_settings.yaml` | Land use preprocessor input/output paths and network settings |
+
+4. **Set user-defined variables in `runSIMOR.bat`**
+
+   Open `runSIMOR.bat` and update the following variables at the top of the file:
+
+   | Variable | Description |
+   |----------|-------------|
+   | `VISUM_VERSION_FILE` | Filename of the Visum version file |
+   | `PROCEDURE_SEQ` | Path to the Visum procedure sequence XML |
+
+### Running the Pipeline
+
+Run:
+```
+runSIMOR.bat
+```
+
+The script automatically calls `setup_environment.bat` to ensure all dependencies are installed and Python paths are set, then runs the following steps in sequence:
+
+1. **Motorized skims** — Using Visum `Visum_Runner.py`. Automatically outputs required files to run non-motorized skims. 
+2. **Non-motorized skim preprocessor** — Prepares walk network inputs via `2zoneSkim_preprocessor.py`.
+3. **Non-motorized skims** — Computes MAZ-to-MAZ and MAZ-to-stop walk skims via `2zoneSkim.py`.
+4. **Land use preprocessor** — Builds ActivitySim-ready land use table via `preprocessor.py`.
+5. **Run ActivitySim** -- Runs ActivitySim -- (not yet implemented)

ext_dependencies/.gitignore

@@ -0,0 +1,4 @@
+# Ignore everything in this directory – these are external dependencies
+# managed by setup_environment.bat and should not be tracked in SimOR.
+*
+!.gitignore

ext_dependencies/maz_skimming/pyproject.toml

@@ -0,0 +1,14 @@
+[project]
+name = "maz-skimming"
+version = "0.1.0"
+description = "Python environment for MAZ-to-MAZ and MAZ-to-stop non-motorized skimming"
+requires-python = ">=3.10,<3.11"
+
+dependencies = [
+    "numpy>=1.24,<2",
+    "pandas>=2.2,<3",
+    "geopandas>=1.0,<2",
+    "pandana==0.7",
+    "pyyaml>=6.0,<7",
+    "shapely>=2.0,<3",
+]