NetworkSettings#

settings activitysim.core.configuration.NetworkSettings#

Network level of service and skims settings

The input for these settings is typically stored in one YAML file, usually called network_los.yaml.

Fields

  • cache_dir (str)

  • read_skim_cache (bool)

  • skim_time_periods (dict)

  • taz_skims (Union[str, activitysim.core.configuration.network.TAZ_Settings])

  • write_skim_cache (bool)

  • zone_system (int)

field cache_dir: str = None#

alternate dir to read/write cache files (defaults to output_dir)

field read_skim_cache: bool = False#

Read cached skims (using numpy memmap) from output directory.

Reading from memmap is much faster than omx, but the memmap is a huge uncompressed file.

field skim_time_periods: dict [Required]#

time period upper bound values and labels

  • time_window - total duration (in minutes) of the modeled time span (Default: 1440 minutes (24 hours))

  • period_minutes - length of time (in minutes) each model time period represents. Must be whole factor of time_window. (Default: 60 minutes)

  • periods - Breakpoints that define the aggregate periods for skims and assignment

  • labels - Labels to define names for aggregate periods for skims and assignment

field taz_skims: Union[str, activitysim.core.configuration.network.TAZ_Settings] = None#

Instructions for how to load and pre-process skim matrices.

If given as a string, it is interpreted as the location for OMX file(s), either as a single file or as a glob-matching pattern for multiple files. The time period for the matrix must be represented at the end of the matrix name and be seperated by a double_underscore (e.g. BUS_IVT__AM indicates base skim BUS_IVT with a time period of AM.

Alternatively, this can be given as a nested dictionary defined via the TAZ_Settings class, which allows for ZARR transformation and pre-processing.

field write_skim_cache: bool = False#

Write memmapped cached skims to output directory.

This is needed if you want to use the cached skims to speed up subsequent runs.

field zone_system: int [Required]#

Which zone system type is used.

  • 1 - TAZ only.

  • 2 - MAZ and TAZ.

  • 3 - MAZ, TAZ, and TAP

previous

MultiprocessStepSlice

next

TAZ_Settings