Guide to existing models

Background Reading

• Official Documentation
• Adventures in CRE
• Other resources on #proforma Slack channel

Code exploration

The easiest way to run a full parcel urbansim model is to clone the sanfran_urbansim repository, since it includes all of the data in the repo. This is a simplified, working-out-of-the-box implementation of an Urbansim parcel model. It may be a little outdated at this point, but is an easy way to get up and running.

Workflow

• To get use out of an urbansim model, you would typically want to estimate coefficients using the steps in Estimation.ipynb, then run a simulation using those settings, using steps in Simulation.ipynb.
• The Orca steps in the simulation notebook that you want to pay attention to are "feasibility", "residential_developer", and "nonresidential_developer".
• These steps are defined in models.py, which calls functions in utils.py.