activitysim Augment documentation of model steps

Augment documentation of model steps

Open bstabler opened this issue 8 years ago • 0 comments

@e-lo

Augment documentation of model steps to include:

Key inputs, required fields, expected formats, and required fields
What settings and parameters files it uses
Where it fits in the grand model run
Where outputs are expected and how can I summarize the results quickly using API?
Re-organize and further document “helper” files
Re-think/name files with similar file names in sub-folders. For example, test and tests; misc.py and - util/misc.py, etc.
Create consistency in file structure and functions.
Create and document a “model step recipe” that is consistent in structure and documentation requirements.

Dec 21 '16 01:12 bstabler