Translation

This section explains the CLI functionality for translating vector data from one zone system to another.

See also

Matrix Translation for translations of demand (or other) matrices.

Zone translation can be called using one of the following sub-commands:

• translate: provide all inputs as arguments; or

• translate-config: provide the path to a config file containing inputs.

More details on both commands are explained below in Sub-Commands.

Note

Both commands perform the exact same translation but they allow the inputs to be provided in slightly different ways.

Sub-Commands

translate

Translate data file to a new zoning system, using given translation lookup file

usage: caf.toolkit translate [options] data_file translation_file

Positional Arguments

data_file

CSV file containing data to be translated

translation_file

CSV file defining how to translate and the weightings to use

Named Arguments

--output_file

Location to save the translated output

Default: translated.csv

--from_column

The column (name or position) in the translation file containing the zone ids to translate from

Default: 0

--to_column

The column (name or position) in the translation file containing the zone ids to translate to

Default: 1

--factor_column

The column (name or position) in the translation file containing the weightings between from and to zones

Default: 2

--zone_column

The column (name or position) in the data file containing the zone ids

Default: 0

translate-config

Translate data file to a new zoning system, using given translation lookup file

usage: caf.toolkit translate-config [options] config_path

Positional Arguments

config_path

path to YAML config file containing run parameters