From 56843ac7f20d2d2c46c17891720b7584f5fdc938 Mon Sep 17 00:00:00 2001 From: navsarmajs Date: Mon, 27 Nov 2023 15:21:51 -0700 Subject: [PATCH 01/11] User guide updates --- docs/howitworks.rst | 1767 ------------------------- docs/images/run_select_components.png | Bin 0 -> 92773 bytes docs/users-guide/example_models.rst | 1724 +++++++++++++++++++++++- docs/users-guide/model_anatomy.rst | 36 +- docs/users-guide/modelsetup.rst | 3 +- docs/users-guide/ways_to_run.rst | 9 +- 6 files changed, 1763 insertions(+), 1776 deletions(-) create mode 100644 docs/images/run_select_components.png diff --git a/docs/howitworks.rst b/docs/howitworks.rst index 4ce01e72b..9c974a9f7 100644 --- a/docs/howitworks.rst +++ b/docs/howitworks.rst @@ -253,1770 +253,6 @@ Back in the main ``run`` command, the final steps are to: * close the data pipeline (and attached HDF5 file) - -Data Schema ------------ - -The ActivitySim data schema depends on the specific implementation of ActivitySim. This section includes information on example data that is likely to be included in most implementations. These tables and skims are defined in the :mod:`activitysim.abm.tables` package. For the best information, documentation developed for a specific implementation of ActivitySim is recommended. - -.. index:: constants -.. index:: households -.. index:: input store -.. index:: land use -.. index:: persons -.. index:: size terms -.. index:: time windows table -.. index:: tours -.. index:: trips - -Data Tables -~~~~~~~~~~~ - -The following tables are currently implemented: - - * households - household attributes for each household being simulated. Index: ``household_id`` (see ``activitysim.abm.tables.households.py``) - * landuse - zonal land use (such as population and employment) attributes. Index: ``zone_id`` (see ``activitysim.abm.tables.landuse.py``) - * persons - person attributes for each person being simulated. Index: ``person_id`` (see ``activitysim.abm.tables.persons.py``) - * time windows - manages person time windows throughout the simulation. See :ref:`time_windows`. Index: ``person_id`` (see the person_windows table create decorator in ``activitysim.abm.tables.time_windows.py``) - * tours - tour attributes for each tour (mandatory, non-mandatory, joint, and atwork-subtour) being simulated. Index: ``tour_id`` (see ``activitysim.abm.models.util.tour_frequency.py``) - * trips - trip attributes for each trip being simulated. Index: ``trip_id`` (see ``activitysim.abm.models.stop_frequency.py``) - -A few additional tables are also used, which are not really tables, but classes: - - * input store - reads input data tables from the input data store - * constants - various constants used throughout the model system, such as person type codes - * shadow pricing - shadow price calculator and associated utility methods, see :ref:`shadow_pricing` - * size terms - created by reading the ``destination_choice_size_terms.csv`` input file. Index - ``segment`` (see ``activitysim.abm.tables.size_terms.py``) - * skims - each model runs requires skims, but how the skims are defined can vary significantly depending on the ActivitySim implementation. The skims class defines Inject injectables to access the skim matrices. The skims class reads the skims from the omx_file on disk. - * table dictionary - stores which tables should be registered as random number generator channels for restartability of the pipeline - -Data Schema -~~~~~~~~~~~ - -Each ActivitySim model includes pipeline data tables, field names, data type, the step that created it, and the -number of columns and rows in the table at the time of creation. The ``other_resources\scripts\make_pipeline_output.py`` script -uses the information stored in the pipeline file to create a table specific to the implementation. - -.. index:: skims -.. index:: omx_file -.. index:: skim matrices - -.. _skims: - -Skims -~~~~~ - -The injectables and omx_file for the example are listed below. -The skims are float64 matrix. - -Skims are named ___