Traveler Traveler Traveler
  • User Guide
  • Demo
  • API
/
  • traveler
    • traveler.log_to_stdout
  • traveler.core
    • traveler.core.array_tools
      • traveler.core.array_tools.dict_concat
      • traveler.core.array_tools.dict_to_dimension
      • traveler.core.array_tools.dict_to_vector
      • traveler.core.array_tools.pytree_concat
      • traveler.core.array_tools.IndexedTable
        • traveler.core.array_tools.IndexedTable.table_name
      • traveler.core.array_tools.Lookup
    • traveler.core.categorical
      • traveler.core.categorical.Categorical
      • traveler.core.categorical.CategoricalArray
        • traveler.core.categorical.CategoricalArray.from_codes_predefined
        • traveler.core.categorical.CategoricalArray.from_pandas
        • traveler.core.categorical.CategoricalArray.from_values
        • traveler.core.categorical.CategoricalArray.from_values_predefined
        • traveler.core.categorical.CategoricalArray.take
        • traveler.core.categorical.CategoricalArray.to_pandas
        • traveler.core.categorical.CategoricalArray.marked_categories
        • traveler.core.categorical.CategoricalArray.ndim
        • traveler.core.categorical.CategoricalArray.shape
        • traveler.core.categorical.CategoricalArray.size
      • traveler.core.categorical.CategoricalType
        • traveler.core.categorical.CategoricalType.mro
    • traveler.core.compression
      • traveler.core.compression.compress_file
      • traveler.core.compression.decompress_file
      • traveler.core.compression.deserialize
      • traveler.core.compression.deserialize_from_file
      • traveler.core.compression.serialize
      • traveler.core.compression.serialize_to_file
      • traveler.core.compression.smart_open
    • traveler.core.digitize
      • traveler.core.digitize.digitize
      • traveler.core.digitize.is_monotonic_increasing
    • traveler.core.downloading
      • traveler.core.downloading.csv_to_parquet
      • traveler.core.downloading.display_sha256_checksums
      • traveler.core.downloading.download_asset
      • traveler.core.downloading.extract_zst
      • traveler.core.downloading.sha256_checksum
    • traveler.core.endog
      • traveler.core.endog.Endogenous
    • traveler.core.errors
      • traveler.core.errors.PerformanceWarning
      • traveler.core.errors.ValidationError
      • traveler.core.errors.ZoneReindexWarning
    • traveler.core.hashing
      • traveler.core.hashing.alphanum_hash
      • traveler.core.hashing.hex_hash
      • traveler.core.hashing.make_prng_keys
      • traveler.core.hashing.prng_subkey
      • traveler.core.hashing.rehash
      • traveler.core.hashing.reproducible_hash
      • traveler.core.hashing.stable_hash
    • traveler.core.lazy
      • traveler.core.lazy.lazy
      • traveler.core.lazy.lazy_property
    • traveler.core.multithread
      • traveler.core.multithread.max_num_threads
      • traveler.core.multithread.multithread_op
        • traveler.core.multithread.multithread_op.debug
    • traveler.core.omx
      • traveler.core.omx.max_len
      • traveler.core.omx.numpy_arrays_from_shared_memory
      • traveler.core.omx.optimize_omx_file
      • traveler.core.omx.OMX
        • traveler.core.omx.OMX.add_blank_lookup
        • traveler.core.omx.OMX.add_blank_matrix
        • traveler.core.omx.OMX.add_lookup
        • traveler.core.omx.OMX.add_matrix
        • traveler.core.omx.OMX.all_matrix_at
        • traveler.core.omx.OMX.change_all_atoms_of_type
        • traveler.core.omx.OMX.change_atom_type
        • traveler.core.omx.OMX.change_mode
        • traveler.core.omx.OMX.close
        • traveler.core.omx.OMX.get_dataframe
        • traveler.core.omx.OMX.get_reverse_lookup
        • traveler.core.omx.OMX.keys
        • traveler.core.omx.OMX.lookup_to_index
        • traveler.core.omx.OMX.to_dask_arrays
        • traveler.core.omx.OMX.to_dataset
        • traveler.core.omx.OMX.to_jax_arrays_3d
        • traveler.core.omx.OMX.to_numpy_arrays_3d
        • traveler.core.omx.OMX.shape
        • traveler.core.omx.OMX.version
      • traveler.core.omx.OMXBadFormat
      • traveler.core.omx.OMXIncompatibleShape
      • traveler.core.omx.OMXNonUniqueLookup
      • traveler.core.omx.OMX_Error
    • traveler.core.parameters
      • traveler.core.parameters.Parameters
        • traveler.core.parameters.Parameters.clear
        • traveler.core.parameters.Parameters.get
        • traveler.core.parameters.Parameters.items
        • traveler.core.parameters.Parameters.keys
        • traveler.core.parameters.Parameters.pop
        • traveler.core.parameters.Parameters.popitem
        • traveler.core.parameters.Parameters.setdefault
        • traveler.core.parameters.Parameters.update
        • traveler.core.parameters.Parameters.values
    • traveler.core.parse_kwds
      • traveler.core.parse_kwds.count_number_of_arguments
      • traveler.core.parse_kwds.parse_and_call
      • traveler.core.parse_kwds.parse_for
      • traveler.core.parse_kwds.prohibit_keyword_only_arguments
      • traveler.core.parse_kwds.who_is
    • traveler.core.store
      • traveler.core.store.AbstractStore
        • traveler.core.store.AbstractStore.assign_on
        • traveler.core.store.AbstractStore.copy
        • traveler.core.store.AbstractStore.get_table_type
        • traveler.core.store.AbstractStore.info
        • traveler.core.store.AbstractStore.push_down_on
        • traveler.core.store.AbstractStore.register_table
        • traveler.core.store.AbstractStore.run_steps
        • traveler.core.store.AbstractStore.table_types
        • traveler.core.store.AbstractStore.validate
        • traveler.core.store.AbstractStore.completed_steps
      • traveler.core.store.StepFunc
    • traveler.core.stored
      • traveler.core.stored.ReferencedTable
        • traveler.core.stored.ReferencedTable.with_index_array
        • traveler.core.stored.ReferencedTable.with_store
        • traveler.core.stored.ReferencedTable.without_store
      • traveler.core.stored.StoredTable
        • traveler.core.stored.StoredTable.info
        • traveler.core.stored.StoredTable.push_down
        • traveler.core.stored.StoredTable.rehash
        • traveler.core.stored.StoredTable.table_fields
        • traveler.core.stored.StoredTable.to_pandas
        • traveler.core.stored.StoredTable.to_polars
        • traveler.core.stored.StoredTable.validate
        • traveler.core.stored.StoredTable.with_store
        • traveler.core.stored.StoredTable.without_store
        • traveler.core.stored.StoredTable.global_random_seed
        • traveler.core.stored.StoredTable.self_idx
        • traveler.core.stored.StoredTable.table_id_col
        • traveler.core.stored.StoredTable.table_name
      • traveler.core.stored.WorkingTable
        • traveler.core.stored.WorkingTable.with_store
        • traveler.core.stored.WorkingTable.without_store
      • traveler.core.stored.from_step
      • traveler.core.stored.lazy_property
    • traveler.core.text_format
      • traveler.core.text_format.bold
      • traveler.core.text_format.format_seconds
    • traveler.core.timers
      • traveler.core.timers.method_timer
      • traveler.core.timers.timer
    • traveler.core.typing
      • traveler.core.typing.get_hinted_shape
      • traveler.core.typing.Categorical
        • traveler.core.typing.Categorical.mark
      • traveler.core.typing.CategoricalMeta
        • traveler.core.typing.CategoricalMeta.mro
      • traveler.core.typing.CategoricalType
      • traveler.core.typing.TypeMaker
        • traveler.core.typing.TypeMaker.Categorical
        • traveler.core.typing.TypeMaker.Int8
        • traveler.core.typing.TypeMaker.Int16
        • traveler.core.typing.TypeMaker.Int32
        • traveler.core.typing.TypeMaker.Int64
        • traveler.core.typing.TypeMaker.Float32
        • traveler.core.typing.TypeMaker.Float64
        • traveler.core.typing.TypeMaker.Bool
      • traveler.core.typing.TypeMakerV
        • traveler.core.typing.TypeMakerV.Categorical
        • traveler.core.typing.TypeMakerV.Int8
        • traveler.core.typing.TypeMakerV.Int16
        • traveler.core.typing.TypeMakerV.Int32
        • traveler.core.typing.TypeMakerV.Int64
        • traveler.core.typing.TypeMakerV.Float32
        • traveler.core.typing.TypeMakerV.Float64
        • traveler.core.typing.TypeMakerV.Bool
    • traveler.core.typing_util
      • traveler.core.typing_util.get_relevant_class_annotations
      • traveler.core.typing_util.is_annotated_type
  • traveler.demo
    • traveler.demo.tour_mode
      • traveler.demo.tour_mode.tour_mode_utilities
    • traveler.demo.work_location
  • traveler.skims
    • traveler.skims.skims_data
    • traveler.skims.omx
      • traveler.skims.omx.OmxSkims
        • traveler.skims.omx.OmxSkims.to_dataset
        • traveler.skims.omx.OmxSkims.to_jax
        • traveler.skims.omx.OmxSkims.to_jax_arrays_3d
    • traveler.skims.zarr
      • traveler.skims.zarr.ZarrSkims
        • traveler.skims.zarr.ZarrSkims.to_jax
  • traveler.steps
    • traveler.steps.SampleHouseholds
      • traveler.steps.SampleHouseholds.run_on
      • traveler.steps.SampleHouseholds.run_via_jax
      • traveler.steps.SampleHouseholds.run_via_pandas
      • traveler.steps.SampleHouseholds.run_via_polars
    • traveler.steps.Step
      • traveler.steps.Step.run_on
    • traveler.steps.compound_step
      • traveler.steps.compound_step.run_on
    • traveler.steps.compute_values
      • traveler.steps.compute_values.compute
      • traveler.steps.compute_values.run_on
    • traveler.steps.sample_logsum_simulate
      • traveler.steps.sample_logsum_simulate.run_on
      • traveler.steps.sample_logsum_simulate.sample_alternatives
      • traveler.steps.sample_logsum_simulate.simulate_choice
    • traveler.steps.simple_choice
      • traveler.steps.simple_choice.analytic_share
      • traveler.steps.simple_choice.analytic_share_loss
      • traveler.steps.simple_choice.analytic_share_loss_grad
      • traveler.steps.simple_choice.calibrate_analytic_share
      • traveler.steps.simple_choice.initialize_for_store
      • traveler.steps.simple_choice.logsum
      • traveler.steps.simple_choice.probability
      • traveler.steps.simple_choice.run_on
      • traveler.steps.simple_choice.simulate_choice
      • traveler.steps.simple_choice.utility
  • traveler.tables
    • traveler.tables.consolidate
    • traveler.tables.jax_to_polars
    • traveler.tables.polars_to_jax
    • traveler.tables.read_table
  • traveler.templates
    • traveler.templates.households
      • traveler.templates.households.Households
        • traveler.templates.households.Households.assign
        • traveler.templates.households.Households.assign_in_place
        • traveler.templates.households.Households.copy
        • traveler.templates.households.Households.from_pandas
        • traveler.templates.households.Households.from_parquet
        • traveler.templates.households.Households.from_polars
        • traveler.templates.households.Households.info
        • traveler.templates.households.Households.random_seed
        • traveler.templates.households.Households.read_csv
        • traveler.templates.households.Households.schema
        • traveler.templates.households.Households.to_dict
        • traveler.templates.households.Households.to_pandas
        • traveler.templates.households.Households.to_polars
        • traveler.templates.households.Households.validate
        • traveler.templates.households.Households.global_random_seed
        • traveler.templates.households.Households.shape
        • traveler.templates.households.Households.household_id
    • traveler.templates.land_use_taz
      • traveler.templates.land_use_taz.LandUseTAZ
        • traveler.templates.land_use_taz.LandUseTAZ.assign
        • traveler.templates.land_use_taz.LandUseTAZ.assign_in_place
        • traveler.templates.land_use_taz.LandUseTAZ.copy
        • traveler.templates.land_use_taz.LandUseTAZ.from_pandas
        • traveler.templates.land_use_taz.LandUseTAZ.from_parquet
        • traveler.templates.land_use_taz.LandUseTAZ.from_polars
        • traveler.templates.land_use_taz.LandUseTAZ.info
        • traveler.templates.land_use_taz.LandUseTAZ.read_csv
        • traveler.templates.land_use_taz.LandUseTAZ.schema
        • traveler.templates.land_use_taz.LandUseTAZ.to_dict
        • traveler.templates.land_use_taz.LandUseTAZ.to_pandas
        • traveler.templates.land_use_taz.LandUseTAZ.to_polars
        • traveler.templates.land_use_taz.LandUseTAZ.validate
        • traveler.templates.land_use_taz.LandUseTAZ.global_random_seed
        • traveler.templates.land_use_taz.LandUseTAZ.shape
        • traveler.templates.land_use_taz.LandUseTAZ.TAZ
    • traveler.templates.persons
      • traveler.templates.persons.Persons
        • traveler.templates.persons.Persons.assign
        • traveler.templates.persons.Persons.assign_in_place
        • traveler.templates.persons.Persons.copy
        • traveler.templates.persons.Persons.from_pandas
        • traveler.templates.persons.Persons.from_parquet
        • traveler.templates.persons.Persons.from_polars
        • traveler.templates.persons.Persons.info
        • traveler.templates.persons.Persons.random_seed
        • traveler.templates.persons.Persons.read_csv
        • traveler.templates.persons.Persons.schema
        • traveler.templates.persons.Persons.to_dict
        • traveler.templates.persons.Persons.to_pandas
        • traveler.templates.persons.Persons.to_polars
        • traveler.templates.persons.Persons.validate
        • traveler.templates.persons.Persons.global_random_seed
        • traveler.templates.persons.Persons.shape
        • traveler.templates.persons.Persons.person_id
    • traveler.templates.randomable
      • traveler.templates.randomable.RandomSeeded
        • traveler.templates.randomable.RandomSeeded.random_seed
        • traveler.templates.randomable.RandomSeeded.global_random_seed
  • traveler.tools
    • traveler.tools.data_download
      • traveler.tools.data_download.download_asset
      • traveler.tools.data_download.sha256_checksum
    • traveler.tools.tar_zst
      • traveler.tools.tar_zst.compress_zst
      • traveler.tools.tar_zst.extract_zst
  • traveler.trees
    • traveler.trees.AttrPyTree
    • traveler.trees.JaxDataset
      • traveler.trees.JaxDataset.assign
      • traveler.trees.JaxDataset.assign_in_place
      • traveler.trees.JaxDataset.copy
      • traveler.trees.JaxDataset.from_parquet
      • traveler.trees.JaxDataset.info
      • traveler.trees.JaxDataset.schema
      • traveler.trees.JaxDataset.to_dict
      • traveler.trees.JaxDataset.validate
      • traveler.trees.JaxDataset.global_random_seed
    • traveler.trees.JaxTable
      • traveler.trees.JaxTable.assign
      • traveler.trees.JaxTable.assign_in_place
      • traveler.trees.JaxTable.copy
      • traveler.trees.JaxTable.from_pandas
      • traveler.trees.JaxTable.from_parquet
      • traveler.trees.JaxTable.from_polars
      • traveler.trees.JaxTable.info
      • traveler.trees.JaxTable.read_csv
      • traveler.trees.JaxTable.schema
      • traveler.trees.JaxTable.to_dict
      • traveler.trees.JaxTable.to_pandas
      • traveler.trees.JaxTable.to_polars
      • traveler.trees.JaxTable.validate
      • traveler.trees.JaxTable.global_random_seed
      • traveler.trees.JaxTable.shape
    • traveler.trees.WithTrace

On this page

  • Submodules
traveler 0 0
Edit this page
  1. Traveler /
  2. API reference /
  3. traveler.templates

traveler.templates#

Submodules#

households

land_use_taz

persons

randomable

Previous
traveler.tables.read_table
Next
traveler.templates.households

© 2026, Driftless Labs

Made with Sphinx and Shibuya theme.