ActivitySim / activitysim

An Open Platform for Activity-Based Travel Modeling
https://activitysim.github.io
BSD 3-Clause "New" or "Revised" License
191 stars 98 forks source link

Automatic generation of high quality data dictionary #528

Open jpn-- opened 2 years ago

jpn-- commented 2 years ago

ActivitySim currently is capable of generating a simple data dictionary using the write_data_dictionary component. The result is a listing of table columns in each table, giving name, dtype (int, float, string, etc.) along with the checkpoint where the column was added. No info is included about what the values mean (e.g. what modes are available, what are the units of measurements, etc.).

We would like it to generate a more robust and high quality dictionary output, similar to static dictionaries provided in these examples:

guyrousseau commented 1 year ago

Following up on Jeff's example above, we updated our ARC ABM data dictionary earlier this year, see https://cdn.atlantaregional.org/wp-content/uploads/abm-data-dictionary-feb-2022-2.pdf