registered_external_example

activitysim.examples.external.registered_external_example(name: str, working_dir: Path, registry: Optional[Path] = None) → Path

Download a registered external example and copy into a working directory.

Parameters:

namestr

The unique name for the registered external example. See activitysim/examples/external_example_manifest.yaml or run list_registered_examples() for the names of the built-in registered examples.

working_dirpath-like

The location to install the external example.

registrypath-like, optional

Provide the file location of an alternative example registry. This should be a yaml file with information about the location of examples. When not provided, the default external example registry is used, which is found at activitysim/examples/external_example_manifest.yaml.

Returns:

Path

The location where the example was installed, generally a subdirectory of working_dir.