Welcome to caf.distribute’s documentation!#

A module of CAF for distributing demand across matrices.

The Common Analytical Framework (CAF) is a collection of transport planning and appraisal functionalities. It’s part of a project to make useful transport related functionality more widely available and easily accessible. Other modules include:

Tool info#

CAF.distribute focusses on tools and models to distribute vectors of data into matrices. Currently, it only contains a self calibrating gravity model that is capable of calibrating data to a single cost distribution area.

Future plans involve enhancing this gravity model to handle multiple cost distribution areas, that is if the gravity model data covered two counties, a different cost distribution could be used for each county, while ensuring all totals still match. There are also plans to move the Iterative Proportional Fitting algorithm over that currently exists in CAF.Toolkit.

Installation#

caf.toolkit can be installed either from pip or conda forge:

pip install caf.distribute

conda install caf.distribute -c conda-forge

Indices and tables#

Contents#