CAF.van

Transport demand model to produce van travel matrices.

[!TIP] For more detailed information including a user guide, tutorials and API reference see the full caf.van documentation

Table of Contents

• Table of Contents
• Overview
  • What does it do?
  • Main Features
    • Work-in-Progress
  • Who is it for?
• Where to get it
  • Installation from GitHub
• Usage
  • Command Line
• Documentation
• What is CAF?
• Contribution
• Contact Us

Overview

What does it do?

CAF.van produces synthetic van demand. This is intended to be assigned to a network as part of a strategic highway transport model. TH model was was developed to produce the van demand for TfN's Highway assignment model (NoHAM), although the tool is flexible to any zoning system given the correct inputs are provided.

Main Features

• Calculating Trip Ends - Distributing total annual GB van trip ends to model zones using land-use data.
• Calculating Distribution - Distributing trip-ends using TfN's gravity model in caf.distribute to create annual demand matrices.
• Caculating Time Period Matrices - Converting van-purpose-split annual demand matrices into van average hour matrices required for modelling.

Work-in-Progress

• Prior Adjustment - Sectorally adjust the synthetic matrices to a set of target matrices.

[!WARNING] These features are work-in-progress and are not available in a released version of caf.van, to access these features a specific branch of caf.van should be installed, see Installation from GitHub.

Who is it for?

• Target audience: Transport Modellers
• CAF Analytical Stage: Modelling

For more details on CAF Analytical Stages see the description within TfN's GitHub homepage

Where to get it

The latest released version are available at the Python Package Index (PyPI) and on Conda.

conda install -c conda-forge caf.van

pip install caf.van

[!TIP]

• See the Quick Start Guide for more detailed instructions.
• See the requirements.txt for the full list of package dependencies.

Installation from GitHub

[!WARNING] Unreleased GitHub versions should not be considered stable.

The latest, unreleased, version can be installed directly from GitHub using:

pip install "git+https://github.com/transport-for-the-north/caf.van"

[!TIP] pip install can install a specific tag, or branch, using @{tag-name} after the git URL.

Usage

CAF.van provides and Command-line (CLI) to use many of it's features without the need to write any Python code, see the Tool Usage section of the user guide for more details.

Command Line

The tool can be run from command line, with the command:

caf.van

See CLI (Usage) for full explanations of the parameters.

Documentation

The code documentation is hosted at https://cafvan.readthedocs.io/en/stable/.

What is CAF?

This tool is part of TfN's Common Analytical Framework (CAF). CAF is Transport for the North's structured suite of analytical tools designed to support transport modelling, appraisal, and strategic decision-making.

More information on CAF and details on other CAF tools can be found on TfN's GitHub Homepage.

Contribution

We encourage use of, and contributions to, the repositories within this organisation, licenses are provided within the repositories and the organisation contribution guide provides details for contributions.

Contact Us

For further information about using this tool or CAF tools in your projects and work contact Transport for the North - TfNOffer@transportforthenorth.com

Go to Top