Package Summary#
The Common Analytical Framework (CAF) modules are built using various Python packages and utilities, which often interconnect. This page provides an overview of all available packages and a brief summary of their usecases, for more details on the release status of packages see CAF Packages
The following sections provide a brief overview of the currently released CAF packages. Each section acts as a small advert for each package, highlighting some highly used functionality and the user interfaces available.
caf.toolkit#
CAF.Toolkit focusses on generic tools and functions that are used across the CAF. A command-line interface is provided for some key features.
The CLI provides access to zone translations for vector or matrix based data. Additionally, caf.toolkit contains the follow functionality:
Configs - Read, write and validate inputs from text configuration files (usually in the YAML format).
Logging - Helps to manage message logging to both files and the terminal.
Cost distributions - Create and handle transport cost distribution data.
Pandas utilities - Additional utility functionality built around the pandas package. Contains common manipulations needed in transport models.
caf.space#
CAF.Space contains geo-processing functionality useful
for transport planners. Primarily it is a tool for generating standard weighting
translations in .csv format describing how to convert between different zoning systems.
CAF space provides a command-line interface and GUI for producing zone correspondence files. Additionally, caf.space contains the following functionality:
Zone Correspondence - Calculate correspondence between two zone systems built from polygons, this can handle point zones and can produced population / employment weighted translations (ZoneTranslation).
Link to Zone - Calculate correspondence between link data and zones (polygons), currently work-in-progress in pull request 27.
Link to Link - Calculate correspondence between two separate links shapefiles, currently work-in-progress in pull request 32.