Make pro forma workflow consistent with other Urbansim models

[pksohn]

As a modeler, I should be able to use the pro forma model in a consistent manner with other urbansim models.

Overview

Currently, the workflow looks like this:

pf = sqftproforma.SqFtProForma()

df = parcels.to_frame()

# add prices for each use
for use in pf.config.uses:
    df[use] = parcel_price_callback(use)

# convert from cost to yearly rent
if residential_to_yearly:
    df["residential"] *= pf.config.cap_rate

d = {}
for form in pf.config.forms:
    print "Computing feasibility for form %s" % form
    d[form] = pf.lookup(form, df[parcel_use_allowed_callback(form)])

far_predictions = pd.concat(d.values(), keys=d.keys(), axis=1)

sim.add_table("feasibility", far_predictions)

I would like to make this consistent with calls to other urbansim models in utils.py, such as hedonic_simulate. The function could look something like this:

cfg = misc.config(cfg)
df = parcels.to_frame()
feasibility = proforma.lookup(df, cfg)
orca.add_table('feasibility', feasibility)

This has the dual benefit of simplifying the function call to the core model, and making the workflow more consistent with other urbansim models.

Details

For now, this simply requires moving these steps from utils.py into the SqftProForma lookup method. New parameters to add to the configuration options are:

• parcel_filter
• residential_to_yearly
• simple_zoning

Refactoring will be considered in the v0.1.1 milestone.