Command line interface (CLI)

Non-application-specific commands

Data pipeline

We have leveraged dagster to run data pipelines, and the command to initiate the dagster UI is below. Once the UI is started, individual assets or jobs can be run; and running dagster --help should provide the needed CLI options. Note that the Dagster UI can be started with dagster dev.

Configuration parameters are available by passing a yaml file to the run of the data pipeline.

A subset of a yaml configuration file is shown below:

ops:
  county_to_county_highway_tons:
    config:
      faf_demand_field: tons_2022
  faf5_truck_demand:
    config:
      faf_demand_field: tons_2022
      unknown_mode_percent: 0.3

See the repo under data/config.yaml for a full example of all configurable parameters for the data pipeline. Or see the full documentation of config parameters

Application-specific commands

Once the package is installed, any of these commands can be run with: irieat <cmd> from the command line (where <cmd> is one of the commands listed below).

Clearing the local cache

The data pipeline downloads file from publicly available sources and keeps them in a local cache. To delete the cache, including all intermediate artifacts, run the following:

clear_cache

Clears the local cache directory

clear_cache [OPTIONS]

Solving

solve

Runs the TAP solution in R using cppRouting

solve [OPTIONS]

Options

-n, --network-file <network_file>

-d, --od-file <od_file>: A parquet file that represents the demand to be used for the TAP

-o, --output-file <output_file>: A parquet file to which the TAP results will be written

-m, --mode <mode>

If specified, uses defaults file outputs for the given mode unless other parameters are passed

Options:: highway | marine | rail

-g, --max-gap <max_gap>: The relative gap used in Algorithm B

-i, --max-iterations <max_iterations>: Max iterations for Algorithm B

Postprocessing

postprocess

Post processes results and save in the default configured cache path

postprocess [OPTIONS]

Options

-s, --solution <solution>: Solution file representing assigned traffic

-g, --solution-graph <solution_graph>: The strongly connected (pickled igraph) graph on which the problem has been solved

-n, --network-geo <network_geo>: The geo file used to represent the underlying network to enable visualization

-m, --mode <mode>

If specified, uses defaults file outputs for the given mode unless other parameters are passed

Options:: highway | marine | rail