OutputTables#

settings activitysim.core.configuration.OutputTables#

Instructions on how to write out final pipeline tables.

Fields:
  • action (str)

  • h5_store (bool)

  • prefix (str)

  • sort (bool)

  • tables (list[typing.Union[str, activitysim.core.configuration.top.OutputTable]])

field action: str [Required]#

Whether to ‘include’ or ‘skip’ the enumerated tables in tables.

field h5_store: bool = False#

Write tables into a single HDF5 store instead of individual CSVs.

field prefix: str = 'final_'#

This prefix is added to the filename of each output table.

field sort: bool = False#

Sort output in each table consistent with well defined column names.

field tables: list[Union[str, OutputTable]] = None#

A list of pipeline tables to include or to skip when writing outputs.

If action is ‘skip’, the values in this list must all be simple strings giving the names of tables to skip. Also, no decoding will be applied to any output tables in this case.

If action is ‘include’, the values in this list can be either simple strings giving the names of tables to include, or OutputTable definitions giving a name and decoding instructions.

If omitted, the all tables are written out and no decoding will be applied to any output tables.