Command Line Interface

ActivitySim includes a Command Line Interface for creating examples and running the model. See activitysim -h for more information.

Create

Create an ActivitySim example setup. See activitysim create -h for more information. More complete examples, including the full scale MTC regional demand model are available for creation by typing activitysim create -l. To create these examples, ActivitySim downloads the large input files from the ActivitySim resources repository.

API

activitysim.cli.create.add_create_args(parser)

Create command args

activitysim.cli.create.create(args)

Create a new ActivitySim configuration from an existing template.

Use the -l flag to view a list of example configurations, then copy to your own working directory. These new project files can be run with the ‘run’ command.

activitysim.cli.create.get_example(example_name, destination)

Copy project data to user-specified directory.

Examples and their data are described in a manifest YAML file. Each example contains at least a name and include field which is a list of files/folders to include in the copied example.

Parameters
example_name: str, name of the example to copy.

Options can be found via list_examples()

destination: name of target directory to copy files to.

If the target directory already exists, project files will be copied into a subdirectory with the same name as the example

Run

Run ActivitySim. See activitysim run -h for more information.

API

activitysim.cli.run.add_run_args(parser, multiprocess=True)

Run command args

activitysim.cli.run.run(args)

Run the models. Specify a project folder using the ‘–working_dir’ option, or point to the config, data, and output folders directly with ‘–config’, ‘–data’, and ‘–output’. Both ‘–config’ and ‘–data’ can be specified multiple times. Directories listed first take precedence.