18 VisionEval Topic Index

Here are detailed descriptions of the documentation available in the VisionEval book.

End User Documentation

1. Introduction to VisionEval
   1. Getting Started
   2. Quick Setup
   3. In Depth Setup
   4. Walkthrough
2. Concept Primer
3. Setting up your own VisionEval model
   1. Selecting a Model
   2. Building model inputs (general)
   3. Building scenarios
4. Details on the three main models in VisionEval
   1. VERSPM
   2. VE-State
   3. VERPAT
5. VisionEval module reference (User level; module by module)
   1. Model Script and Modules
   2. Module
   3. Inputs and Outputs
   4. module_docs
   5. Rebuilding Packages (PUMS, PowertrainsAndFuels
6. VEModel Framework API
   1. visioneval.cnf environment (cascading)
   2. Model setup
      1. Geography and extra fields, deflators, units and display units
      2. Model scripts (structure, runModule parameters)
      3. Inputs (including search path and scenarios)
      4. Stages (including StartFrom and BaseScenario)
      5. Scenarios (Manual and category combinations)
   3. Results / Exporting
      1. Results (including Logs, ModelState_ls and Datastore)
      2. Outputs
   4. Queries
      1. Designing (with examples)
      2. Running and exporting
   5. R Visualizer

18.1 Developer Documentation

1. Repository Structure and Build Tools
   2. Github and Development Environment Tutorial
      1. Cloning and building tutorial
      2. Directory tree of sources in Git repository
      3. Where built stuff goes
   3. Development Environment in depth
      1. Directories
      2. ve.build / ve.run / ve.test I. Build scripts, config, components
      3. Make from command line, Makefile
   4. Startup scripts
      1. launch.bat / .Rprofie
      2. VisionEval.R
      3. build/VisionEval-dev.R
2. Debugging VisionEval
   1. Debug tools
      1. Post-mortem with Load Model
      2. R debugger (with ‘src’ for modules)
      3. ve.test(pkgLoad=TRUE), for framework only
   2. VESnapshot
3. VisionEval Framework 3.0
   1. Oveview of how it works
      1. Model Running
      2. Packages versus Modules
      3. Model Script Structure
   2. Module Structure (for module developers)d
      1. Specifications
      2. Module Function
      3. Estimation / Package Data
      4. Module Docs
   3. visioneval package
      1. Source Files
      2. Functions
      3. Function Interdependencies / Workflows
   4. VEModel package
      1. Source Files
      2. How VEModel functions work / relate to visioneval framework