create_example

activitysim.core.workflow.create_example(example_name: str, directory: Optional[Union[Path, str]] = None, temp: bool = False) → State

Create an example model.

Parameters:

example_namestr

directoryPath-like, optional

Install the example into this directory.

tempbool, default False

Install the example into a temporary directory tied to the returned State object. Cannot be set to True if directory is given.

Returns:

State