Project Meeting 2023.10.03

Agenda

• User's Guide Documentation

Action Items

• Consortium to review and comment on the User's Guide. outline in two weeks.

Meeting Notes

• Michelle (CS) presented a proposed outline for the User's Guide.
• Currently, there are two Guides - one for Users and one for Developers. The intention is that there is a simplified User's Guide for the day-to-day users and then another set of information for developers for things that typical users will probably never need to know. All the information is available to everyone, but the point is to curate the information to best fit very different needs.
  • There could be three types of User's Guides: 1) for basic use of the model; 2) for users that own a specific implementation and will continue to develop it for production; 3) developers who are primarily working on revising the core code, such as the bench consultants.
• The initial vision for this update it to curate a User's Guide that gets to some basic questions/functions - what would everyone person who will run ActivitySim need to know? Questions such as:
  • How do I install it?
  • How do I run it?
  • How do I adjust my settings file to fit on my machine and make sure it runs well?
  • How to do a partial model run?
• TO DO: at the end of this User's Guide update, a perfect guide is not expected but a framework will be built with some/minimal new content. CS will also produce some recommendations for future updates of the User's and Developer's Guide. This is intended to be a parking lot of considerations.
• Next Steps:
  • Consortium to review and comment on the User's Guide. outline in two weeks.