CommuteTripEnds

class caf.van.lgv_model.CommuteTripEnds(input_paths, model_zones)

Functionality for generating the LGV commuting segment trip productions and attractions.

Parameters:

• inputs (LGVInputPaths) – Dataclass storing paths to all the input files for the LGV model.

• model_zones (pd.Series) – Full list of model zones.

• input_paths (lgv_inputs.LGVInputPaths)

See also

caf.van.lgv_inputs

Module with functions for reading some inputs.

Attributes

COMMUTING_INPUTS_SHEET_HEADERS
EMPLOYMENT_AGGREGATION
HH_PROJECTIONS_HEADER
HH_RENAME
attractions	Trip productions for each zone (index) and with columns Total, Skilled trades and Drivers.
inputs_summary	Returns a summary table of class inputs.
productions	Trip productions for each zone (index) and with columns Total, Skilled trades and Drivers.
trips	dictionary with keys Skilled trades and Drivers, with values being the trip dataframes, each with productions and attractions as columns and zones as indices.

Methods

__init__(input_paths, model_zones)	Initialise class by checking all input paths are in input dict and all input files exist.
calc_trip_ends()	Takes production and attraction dataframes with skilled trades and drivers as columns and zones as indices and creates skilled trade and driver trip dataframes with productions and attractions as columns and zones as indices.
estimate_attractions()	Estimates trip attractions.
estimate_productions()	Reads in files and estimates trip productions by zone and employment segment.

Attributes Documentation

COMMUTING_INPUTS_SHEET_HEADERS = {'Commute Warehouse Parameters': {'Parameter': <class 'str'>, 'Value': <class 'str'>}, 'Commute trips by land use': {'Land use at trip end': <class 'str'>, 'Trips': <class 'float'>}, 'Commute trips by main usage': {'Main usage': <class 'str'>, 'Trips': <class 'float'>}, 'Delivery Segment Parameters': {'Parameter': <class 'str'>, 'Value': <class 'str'>}, 'Parameters': {'Parameter': <class 'str'>, 'Value': <class 'float'>}}

EMPLOYMENT_AGGREGATION = {'Non-Construction': [1, 2, 3, 4, 5, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19]}

HH_PROJECTIONS_HEADER = {'Area Description': <class 'str'>, 'HHs': <class 'float'>, 'Jobs': <class 'float'>}

HH_RENAME = {'Area Description': 'zone', 'HHs': 'households', 'Jobs': 'jobs'}

attractions

Trip productions for each zone (index) and with columns Total, Skilled trades and Drivers.

Type:

pd.DataFrame

inputs_summary

Returns a summary table of class inputs.

Returns:

Summary of inputs

Return type:

pd.DataFrame

productions

Trip productions for each zone (index) and with columns Total, Skilled trades and Drivers.

Type:

pd.DataFrame

trips

dictionary with keys Skilled trades and Drivers, with values being the trip dataframes, each with productions and attractions as columns and zones as indices.

Type:

Dict[pd.DataFrame]