Skip to content

Commit

Permalink
Updated write_tables doc string.
Browse files Browse the repository at this point in the history
  • Loading branch information
stefancoe committed Dec 12, 2023
1 parent 4b33bca commit c636cfb
Showing 1 changed file with 17 additions and 2 deletions.
19 changes: 17 additions & 2 deletions activitysim/core/steps/output.py
Original file line number Diff line number Diff line change
Expand Up @@ -227,8 +227,13 @@ def write_data_dictionary(state: workflow.State) -> None:
@workflow.step
def write_tables(state: workflow.State) -> None:
"""
Write pipeline tables as csv files (in output directory) as specified by output_tables list
in settings file.
Write pipeline tables as csv or parquet files (in output directory) as specified
by output_tables list in settings file. Output to parquet or a single h5 file is
also supported.
'h5_store' defaults to False, which means the output will be written out to csv.
'file_type' defaults to 'csv' but can also be used to specify 'parquet' or 'h5'.
When 'h5_store' is set to True, 'file_type' is ingored and the outputs are written to h5.
'output_tables' can specify either a list of output tables to include or to skip
if no output_tables list is specified, then all checkpointed tables will be written
Expand Down Expand Up @@ -262,6 +267,16 @@ def write_tables(state: workflow.State) -> None:
tables:
- households
To write tables to parquet files, use the file_type setting:
::
output_tables:
file_type: parquet
action: include
tables:
- households
Parameters
----------
output_dir: str
Expand Down

0 comments on commit c636cfb

Please sign in to comment.