External Examples

Tools to download and use example models from external sources.

The tools in this module allow for automated access to external example models, which are not necessarily maintained or supported by the ActivitySim Consortium. These models can be test-sized or full scale representations of models operated by various agencies, and can contain thousands of zones and/or millions of simulated households.

Functions

registered_external_example(name, working_dir)	Download a registered external example and copy into a working directory.
download_external_example(working_dir[, ...])	Download an external example.
exercise_external_example(name, working_dir)	Use pytest to ensure that an external example is functioning correctly.
list_registered_examples([registry])	Read a list of registered example names.
default_cache_dir()	Get the default external example cache directory.